Generated CLI Reference¶
This page is generated from the live bijux-dag Clap command definitions.
It records the stable v0.4.0 operator surface exactly as the product presents
it through bijux-dag --help. Experimental, simulated, and internal routes are
deliberately excluded from this page and listed separately in
gated-command-inventory.md.
The replayable-run claim reproduced in the generated help below is bounded by the Replay Contract, including its retained evidence requirements and explicit refusal conditions.
Placeholder Conventions¶
${GRAPH}: DAG graph file such asevidence/dag/authoring/examples/minimal_consumer.dag.json${GRAPH_A}and${GRAPH_B}: two graph revisions to compare${RUNS_ROOT}: retained run root such asartifacts/bijux-dag/runs${RUN_DIR}: one retained run directory such as${RUNS_ROOT}/run-20260708-101500${RUN_DIR_A}and${RUN_DIR_B}: two retained run directories${RUN_ID},${RUN_ID_A},${RUN_ID_B}: retained run ids under${RUNS_ROOT}${CACHE_DIR}: cache root such asartifacts/bijux-dag/cache${NODE_FINGERPRINT}: one persisted node fingerprint for cache packing${CACHE_KEY},${CACHE_KEY_A},${CACHE_KEY_B}: cache keys reported bycache explainorrunoutput${ARTIFACT_ID}: artifact id such asreportorsummary${DELIVERABLES_ROOT}: deliverables root such asartifacts/bijux-dag/deliverables${DIAGNOSTICS_DIR}: diagnostics bundle output directory such asartifacts/bijux-dag/run-diagnostics
Stable Root Surface¶
validateartifact-inspectartifactcommandsplanrunreplayrunsdiffexplainverifydoctorcacheversion
Root Help¶
bijux-dag v0.4.1 is a local-first DAG runtime for reproducible workflows with explicit graph contracts, deterministic execution records, verified artifacts, cache explanation, and replayable run bundles.
Usage: bijux-dag [OPTIONS] [COMMAND]
Commands:
validate
artifact-inspect
artifact
commands
plan
run
replay
runs
diff
explain
verify
doctor
cache
version
help Print this message or the help of the given subcommand(s)
Options:
--json
--quiet
-h, --help
Print help
v0.4.0 surface truth table:
stable: validate, plan, run, replay, runs ..., artifact, artifact-inspect, diff, explain, verify, doctor, cache, version, commands
experimental: hidden explicit-path routes require deliberate inventory with `bijux-dag commands --lane experimental`
simulated: modeled platform namespaces require `bijux-dag commands --lane simulated` to inventory and BIJUX_DAG_ENABLE_SIMULATED=1 to execute
internal: maintainer namespaces require `bijux-dag commands --lane internal` to inventory and BIJUX_DAG_ENABLE_INTERNAL=1 to execute
future: generic hpc beyond the shared-filesystem slurm lane, public remote workers, and public scheduler services are not part of v0.4.0
Use `bijux-dag commands` for the stable operator surface and add `--lane` only when you intentionally need repository-owned non-stable routes.
validate¶
Examples¶
- Validate one graph before planning or execution:
- Emit validation diagnostics in JSON:
Help¶
Usage: validate [OPTIONS] <DAGS>...
Arguments:
<DAGS>...
Options:
--strict
--print-fingerprints
--explain
-h, --help
Print help
artifact-inspect¶
Examples¶
- Inspect one retained artifact by run directory and artifact id:
- Emit artifact inspection in JSON:
Help¶
Usage: artifact-inspect <RUN_DIR> <ARTIFACT_ID>
Arguments:
<RUN_DIR>
<ARTIFACT_ID>
Options:
-h, --help
Print help
artifact¶
Examples¶
- List retained artifacts for one run:
- Emit machine-readable lineage for one retained artifact:
Help¶
Usage: artifact <COMMAND>
Commands:
registry
lineage
promote
retention
help Print this message or the help of the given subcommand(s)
Options:
-h, --help
Print help
artifact registry¶
Examples¶
- Inspect the retained artifact registry for one run:
- Inspect the same registry in JSON:
Help¶
artifact lineage¶
Examples¶
- Show lineage for every retained artifact in one run:
- Focus lineage output on one artifact id in JSON:
Help¶
Usage: lineage [OPTIONS] <RUN_DIR>
Arguments:
<RUN_DIR>
Options:
--artifact-id <ARTIFACT_ID>
-h, --help
Print help
artifact promote¶
Examples¶
- Promote one retained artifact into the release deliverables tree:
- Emit the promotion result in JSON for automation:
bijux-dag --json artifact promote ${RUN_DIR} ${ARTIFACT_ID} --deliverables-root ${DELIVERABLES_ROOT} --to release
Help¶
Usage: promote [OPTIONS] --deliverables-root <DELIVERABLES_ROOT> <RUN_DIR> <ARTIFACT_ID>
Arguments:
<RUN_DIR>
<ARTIFACT_ID>
Options:
--deliverables-root <DELIVERABLES_ROOT>
--to <TO>
[default: release]
-h, --help
Print help
artifact retention¶
Examples¶
- Summarize retained artifact roots under one runs directory:
- Inspect retained artifact roots in JSON:
Help¶
commands¶
Examples¶
- List the stable public operator surface:
- Capture the stable command inventory in JSON:
Help¶
Usage: commands [OPTIONS]
Options:
--groups
--lane <LANES>
[possible values: stable, experimental, simulated, internal]
-h, --help
Print help
plan¶
Examples¶
- Preview one run layout before execution:
- Capture planning diagnostics in JSON:
Help¶
Usage: plan <COMMAND>
Commands:
explain
diagnostics
diff
equivalence
closure
backfill
help Print this message or the help of the given subcommand(s)
Options:
-h, --help
Print help
plan explain¶
Examples¶
- Preview run layout, path bindings, and scheduler estimates:
- Capture the same planning payload in JSON:
Help¶
Usage: explain [OPTIONS] <DAGS>...
Arguments:
<DAGS>...
Options:
--out <OUT>
--run-id <RUN_ID>
--cache-dir <CACHE_DIR>
--absolute-path-policy <ABSOLUTE_PATH_POLICY>
[default: allow-literal]
[possible values: allow-literal, deny-literal]
--jobs <JOBS>
[default: 1]
--cpu-budget <CPU_BUDGET>
--memory-budget-mb <MEMORY_BUDGET_MB>
--gpu-device-budget <GPU_DEVICE_BUDGET>
--resource-capacity <name=count>
declare a named runtime capacity as <name=count>; repeat for resources such as license tokens or database slots
--from-node <FROM_NODE>
--to-node <TO_NODE>
--select <SELECT>
--exclude <EXCLUDE>
--dependency-closure
-h, --help
Print help
plan diagnostics¶
Examples¶
- Inspect planner diagnostics for one graph:
- Capture planner diagnostics in JSON:
Help¶
plan diff¶
Examples¶
- Compare two graph revisions through the planner surface:
- Emit the planner diff in JSON:
Help¶
plan equivalence¶
Examples¶
- Ask whether two graph files still execute the same logical workflow:
- Capture the equivalence decision in JSON:
Help¶
plan closure¶
Examples¶
- Resolve the upstream and downstream closure for a selected node set:
- Emit the closure result in JSON:
Help¶
Usage: closure [OPTIONS] <DAGS>...
Arguments:
<DAGS>...
Options:
--select <SELECT>
-h, --help
Print help
plan backfill¶
Examples¶
- Plan a backfill window with explicit partition keys:
bijux-dag plan backfill --window-start-unix-ms 1711929600000 --window-end-unix-ms 1712016000000 --partition-key tenant=atlas --partition-key region=se
- Emit the backfill plan in JSON:
bijux-dag --json plan backfill --window-start-unix-ms 1711929600000 --window-end-unix-ms 1712016000000 --partition-key tenant=atlas
Help¶
Usage: backfill [OPTIONS] --window-start-unix-ms <WINDOW_START_UNIX_MS> --window-end-unix-ms <WINDOW_END_UNIX_MS>
Options:
--window-start-unix-ms <WINDOW_START_UNIX_MS>
--window-end-unix-ms <WINDOW_END_UNIX_MS>
--partition-key <PARTITION_KEY>
-h, --help
Print help
run¶
Examples¶
- Execute one graph with explicit runtime inputs:
bijux-dag run ${GRAPH} --out ${RUNS_ROOT} --input source=artifacts/bijux-dag/input.txt --progress compact
- Run the same workflow in machine-readable mode with streamed progress snapshots:
bijux-dag --json run ${GRAPH} --out ${RUNS_ROOT} --input source=artifacts/bijux-dag/input.txt --progress compact
Help¶
Usage: run [OPTIONS] --out <OUT> <DAGS>...
Arguments:
<DAGS>...
Options:
--out <OUT>
--input <INPUT>
--inputs-file <INPUTS_FILE>
--run-id <RUN_ID>
--resume-run <RESUME_RUN>
resume an existing run directory by run id, reusing only nodes whose persisted outputs still match their recorded evidence
--resume-failure-mode <RESUME_FAILURE_MODE>
choose whether nodes that cannot be safely reused are rerun or rejected during resume
[default: rerun-incomplete]
[possible values: rerun-incomplete, reject-incomplete]
--latest <LATEST>
--jobs <JOBS>
[default: 1]
--cpu-budget <CPU_BUDGET>
--memory-budget-mb <MEMORY_BUDGET_MB>
--gpu-device-budget <GPU_DEVICE_BUDGET>
--resource-capacity <name=count>
declare a named runtime capacity as <name=count>; repeat for resources such as license tokens or database slots
--node-timeout-ms <NODE_TIMEOUT_MS>
--run-timeout-ms <RUN_TIMEOUT_MS>
--run-timeout-behavior <RUN_TIMEOUT_BEHAVIOR>
[default: finish-running]
[possible values: finish-running, cancel-running]
--deny-network
deny declared network effects; shell execution does not firewall sockets, and container execution only enforces this when the runtime can honor a no-network mode
--deny-env
deny declared environment effects; this is a policy gate over declared DAG effects, not a syscall sandbox over arbitrary process reads
--deny-clock
deny declared clock effects; this does not virtualize wall clock access inside spawned processes
--clean-env
run with the curated bijux environment instead of inheriting the full parent environment; this shapes environment variables only
--hermetic
enable the best-effort local policy profile by forcing --deny-network, --deny-clock, and --clean-env; this does not claim syscall sandboxing or host filesystem isolation
--select <SELECT>
--exclude <EXCLUDE>
--to-node <TO_NODE>
--dependency-closure
--materialize-inputs <MATERIALIZE_INPUTS>
[default: copy]
[possible values: copy, hardlink, symlink]
--cache <CACHE>
[default: off]
[possible values: off, read, readwrite]
--cache-dir <CACHE_DIR>
--remote-cache-dir <REMOTE_CACHE_DIR>
--absolute-path-policy <ABSOLUTE_PATH_POLICY>
[default: allow-literal]
[possible values: allow-literal, deny-literal]
--preflight-only
--explain-scheduling
--progress <PROGRESS>
show live progress for `bijux-dag run`; `compact` renders operator-readable updates on stderr in human mode and streams `dag.run.progress` JSON lines on stdout when `--json` is active
[default: off]
[possible values: off, compact]
--backend <BACKEND>
choose the node execution backend; `kubernetes` runs container nodes as Kubernetes Jobs through kubectl plus a shared persistent volume claim, and `slurm` submits nodes through sbatch and polls sacct until each job reaches a terminal state
[default: local]
[possible values: local, kubernetes, slurm]
--kubernetes-namespace <KUBERNETES_NAMESPACE>
[default: bijux]
--kubernetes-volume-claim <KUBERNETES_VOLUME_CLAIM>
--kubernetes-shared-root <KUBERNETES_SHARED_ROOT>
--slurm-queue <SLURM_QUEUE>
[default: general]
--slurm-partition <SLURM_PARTITION>
[default: cpu]
-h, --help
Print help
replay¶
Examples¶
- Replay one retained run into a new output root:
- Capture a replay proof request in JSON:
Help¶
Usage: replay [OPTIONS] --out <OUT> [RUN_DIR]
Arguments:
[RUN_DIR]
Options:
--source-run-id <SOURCE_RUN_ID>
resolve the replay source run by run id instead of passing a source run directory path
--source-run-root <SOURCE_RUN_ROOT>
root directory used when resolving --source-run-id; defaults to the replay output root when omitted
--out <OUT>
--dry-run
--sandbox
forbid replay outputs from being written inside the source run directory; this is a write-boundary check, not a process sandbox
--prove
--reuse-cache
--cache <CACHE>
[default: off]
[possible values: off, read, readwrite]
--jobs <JOBS>
[default: 1]
--run-id <RUN_ID>
--cpu-budget <CPU_BUDGET>
--memory-budget-mb <MEMORY_BUDGET_MB>
--gpu-device-budget <GPU_DEVICE_BUDGET>
--resource-capacity <name=count>
declare a named runtime capacity as <name=count>; repeat for resources such as license tokens or database slots
--deny-network
deny declared network effects; shell execution does not firewall sockets, and container execution only enforces this when the runtime can honor a no-network mode
--deny-env
deny declared environment effects; this is a policy gate over declared DAG effects, not a syscall sandbox over arbitrary process reads
--deny-clock
deny declared clock effects; this does not virtualize wall clock access inside spawned processes
--clean-env
run with the curated bijux environment instead of inheriting the full parent environment; this shapes environment variables only
--hermetic
enable the best-effort local policy profile by forcing --deny-network, --deny-clock, and --clean-env; this does not claim syscall sandboxing or host filesystem isolation
--from-node <FROM_NODE>
--select <SELECT>
--exclude <EXCLUDE>
--dependency-closure
--materialize-inputs <MATERIALIZE_INPUTS>
[default: copy]
[possible values: copy, hardlink, symlink]
--remote-cache-dir <REMOTE_CACHE_DIR>
-h, --help
Print help
runs¶
Examples¶
- List retained runs under one root:
- Summarize retained run history in JSON:
Help¶
Usage: runs <COMMAND>
Commands:
list
show
inspect
history
id-explain
tree
timeline
scheduler-checkpoint
stop
diff
verify
doctor
explain-failure
summary
compare
trend
failures
flakes
diagnostics-bundle
index
help Print this message or the help of the given subcommand(s)
Options:
-h, --help
Print help
runs list¶
Examples¶
- Enumerate retained runs under one root:
- Emit the run list in JSON:
Help¶
runs show¶
Examples¶
- Show compact status and timing for one retained run:
- Emit the compact run view in JSON:
Help¶
runs inspect¶
Examples¶
- Inspect one retained run by id:
- Emit structured run inspection in JSON:
Help¶
Usage: inspect --root <ROOT> <RUN_ID>
Arguments:
<RUN_ID>
Options:
--root <ROOT>
-h, --help
Print help
runs history¶
Examples¶
- Filter retained history by status and selection:
- Capture filtered retained history in JSON:
Help¶
Usage: history [OPTIONS] --root <ROOT>
Options:
--root <ROOT>
--status <STATUS>
--graph <GRAPH>
--source <SOURCE>
--offset <OFFSET>
--limit <LIMIT>
--select <SELECT>
-h, --help
Print help
runs id-explain¶
Examples¶
- Explain how one retained run id resolves under a root:
- Emit the run-id explanation in JSON:
Help¶
Usage: id-explain --root <ROOT> <RUN_ID>
Arguments:
<RUN_ID>
Options:
--root <ROOT>
-h, --help
Print help
runs tree¶
Examples¶
- Render the node tree for one retained run:
- Emit the retained run tree in JSON:
Help¶
runs timeline¶
Examples¶
- Inspect ordered execution events for one retained run:
- Filter timeline events and emit them in JSON:
Help¶
Usage: timeline [OPTIONS] --root <ROOT> <RUN_ID>
Arguments:
<RUN_ID>
Options:
--root <ROOT>
--node <NODE>
--event <EVENT>
--since-unix-ms <SINCE_UNIX_MS>
--until-unix-ms <UNTIL_UNIX_MS>
-h, --help
Print help
runs scheduler-checkpoint¶
Examples¶
- Inspect the retained scheduler checkpoint for one run:
- Emit the retained scheduler checkpoint in JSON:
Help¶
Usage: scheduler-checkpoint --root <ROOT> <RUN_ID>
Arguments:
<RUN_ID>
Options:
--root <ROOT>
-h, --help
Print help
runs stop¶
Examples¶
- Request a stop for one retained run id:
- Capture the stop request response in JSON:
Help¶
runs diff¶
Examples¶
- Compare two retained run directories inside the runs lane:
- Emit the runs diff in JSON:
Help¶
Usage: diff [OPTIONS] <RUN_A> <RUN_B>
Arguments:
<RUN_A>
<RUN_B>
Options:
--mode <MODE>
[default: semantic]
[possible values: summary, semantic, artifact, provenance, timing, policy, cache, raw]
--node <NODE>
--explain
-h, --help
Print help
runs verify¶
Examples¶
- Verify one retained run by id:
- Emit retained-run verification in JSON:
Help¶
Usage: verify [OPTIONS] --root <ROOT> <RUN_ID>
Arguments:
<RUN_ID>
Options:
--root <ROOT>
--deep
--strict
-h, --help
Print help
runs doctor¶
Examples¶
- Diagnose one retained run by id:
- Emit the run diagnosis in JSON:
Help¶
Usage: doctor --root <ROOT> <RUN_ID>
Arguments:
<RUN_ID>
Options:
--root <ROOT>
-h, --help
Print help
runs explain-failure¶
Examples¶
- Explain the first causal failure for one retained run:
- Capture the same failure explanation in JSON:
Help¶
Usage: explain-failure --root <ROOT> <RUN_ID>
Arguments:
<RUN_ID>
Options:
--root <ROOT>
-h, --help
Print help
runs summary¶
Examples¶
- Summarize retained history under one root:
- Emit the retained summary in JSON:
Help¶
runs compare¶
Examples¶
- Compare two retained run ids under one root:
- Emit the retained-run comparison in JSON:
Help¶
Usage: compare --root <ROOT> <RUN_A> <RUN_B>
Arguments:
<RUN_A>
<RUN_B>
Options:
--root <ROOT>
-h, --help
Print help
runs trend¶
Examples¶
- Review one analytics point per retained run:
- Emit the trend report in JSON:
Help¶
runs failures¶
Examples¶
- Aggregate failed node kinds across retained history:
- Capture the failure aggregation in JSON:
Help¶
runs flakes¶
Examples¶
- Find graph fingerprints with mixed retained outcomes:
- Emit the flake report in JSON:
Help¶
runs diagnostics-bundle¶
Examples¶
- Assemble a diagnostics bundle for one retained run:
- Capture diagnostics-bundle metadata in JSON:
Help¶
Usage: diagnostics-bundle [OPTIONS] --root <ROOT> --out <OUT> <RUN_ID>
Arguments:
<RUN_ID>
Options:
--root <ROOT>
--out <OUT>
--redact
-h, --help
Print help
runs index¶
Examples¶
- Rebuild or inspect the retained run index under one root:
- Emit the run index payload in JSON:
Help¶
diff¶
Examples¶
- Compare two retained runs semantically:
- Capture an explained semantic diff in JSON:
Help¶
Usage: diff [OPTIONS] <RUN_A> <RUN_B>
Arguments:
<RUN_A>
<RUN_B>
Options:
--mode <MODE>
[default: semantic]
[possible values: summary, semantic, artifact, provenance, timing, policy, cache, raw]
--node <NODE>
--explain
-h, --help
Print help
explain¶
Examples¶
- Explain one retained run at a high level:
- Explain one retained node in JSON:
Help¶
Usage: explain [OPTIONS] <RUN_DIR>
Arguments:
<RUN_DIR>
Options:
--node <NODE>
-h, --help
Print help
verify¶
Examples¶
- Verify one retained run directory directly:
- Capture the verification result in JSON:
Help¶
Usage: verify [OPTIONS] <RUN_DIR>
Arguments:
<RUN_DIR>
Options:
--deep
--strict
-h, --help
Print help
doctor¶
Examples¶
- Inspect runtime, cache, and environment readiness:
- Capture the doctor report in JSON:
Help¶
cache¶
Examples¶
- Review cache statistics before a cleanup or replay decision:
- Verify cache integrity in machine-readable form:
Help¶
Usage: cache <COMMAND>
Commands:
ls
pack
unpack
gc
verify
explain
stats
prune-simulate
diff
help Print this message or the help of the given subcommand(s)
Options:
-h, --help
Print help
cache ls¶
Examples¶
- List cache entries under one cache root:
- List cache entries in JSON:
Help¶
cache pack¶
Examples¶
- Pack one cache entry for transfer or evidence capture:
bijux-dag cache pack ${NODE_FINGERPRINT} --out artifacts/bijux-dag/cache-entry.tar.zst --cache-dir ${CACHE_DIR}
- Emit the packed-entry metadata in JSON:
bijux-dag --json cache pack ${NODE_FINGERPRINT} --out artifacts/bijux-dag/cache-entry.tar.zst --cache-dir ${CACHE_DIR}
Help¶
Usage: pack [OPTIONS] --out <OUT> <NODE_FP>
Arguments:
<NODE_FP>
Options:
--out <OUT>
--cache-dir <CACHE_DIR>
-h, --help
Print help
cache unpack¶
Examples¶
- Restore one packed cache entry into a cache root:
- Capture the unpack result in JSON:
Help¶
Usage: unpack [OPTIONS] <PACK>
Arguments:
<PACK>
Options:
--cache-dir <CACHE_DIR>
-h, --help
Print help
cache gc¶
Examples¶
- Run cache garbage collection on one cache root:
- Capture the cleanup result in JSON:
Help¶
cache verify¶
Examples¶
- Verify cache integrity before relying on reuse:
- Verify cache integrity and emit JSON:
Help¶
cache explain¶
Examples¶
- Explain one cache key and the expected adapter contract:
- Emit the cache explanation in JSON:
Help¶
Usage: explain [OPTIONS] --key <KEY>
Options:
--cache-dir <CACHE_DIR>
--key <KEY>
--expected-adapter-id <EXPECTED_ADAPTER_ID>
--expected-adapter-version <EXPECTED_ADAPTER_VERSION>
-h, --help
Print help
cache stats¶
Examples¶
- Summarize cache occupancy and entry counts:
- Emit cache statistics in JSON:
Help¶
cache prune-simulate¶
Examples¶
- Preview which cache entries a cleanup policy would remove:
- Review the same cleanup simulation in JSON:
Help¶
cache diff¶
Examples¶
- Compare two cache entries for drift:
- Emit the cache diff in JSON:
Help¶
Usage: diff [OPTIONS] --key-a <KEY_A> --key-b <KEY_B>
Options:
--cache-dir <CACHE_DIR>
--key-a <KEY_A>
--key-b <KEY_B>
-h, --help
Print help
version¶
Examples¶
- Print the product version and build identity:
- Emit version identity in JSON: