CLI
sane runs workflows and inspects saved results:
sane workflow [options]
sane view <command> [workflow_save] [options]
Use --help at any level to see the available commands or their options:
sane --help
sane workflow --help
sane view --help
sane view logs --help
Running Workflows
Use workflow to invoke the runner:
sane workflow -p ./workflow -a simulate --run
See Running Workflows for action selection, execution, graph output, logging, and virtual relaunches. See Paths for workflow discovery and Saves for saved-state behavior.
Additional options:
-s PATTERN,--search_pattern PATTERNSelect files to load. Repeat for multiple patterns. Defaults to
*.json,*.jsonc, and*.py. Quote patterns to prevent shell expansion.-w PATH,--working_dir PATHSet the working directory for actions. Defaults to
./; an action-specific working directory takes precedence.-ll PATH,--log_location PATHSet the log directory. Defaults to
./log.-m MODE,--mode MODEControl reuse of saved state:
0uses workflow state (the default),1always runs requested actions, and2also invalidates downstream actions. For example, rerun a selected action with--run --mode 1.
Inspecting Results
view reads orchestrator.json from ./tmp by default. Supply a directory
as the optional workflow_save argument to inspect another run, or use
--filename NAME to read a different saved-state filename:
sane view summary ./results/trial
Command |
Result |
|---|---|
|
Report each action’s execution status. Use |
|
Report each action’s saved state. Use |
|
List action log paths. Use |
|
Report success or failure, action and error counts, and runtimes. Exits with a nonzero status when any saved action has failed. |
|
Plot recorded resource usage. Prompts for a run index; pressing Enter selects index 0. Requires Matplotlib. |
After a run, check its summary and locate logs for failed actions:
sane view summary
sane view logs --errors --relative_path
logs lists paths rather than displaying file contents. Use --runlog to
select logs from inside the action launch. Both logs and summary accept
--markdown for reports:
sane view logs --errors --runlog --markdown
sane view summary --markdown
To inspect resource events, add arrows or stems to the usage plot:
sane view usage --arrows --stems
Legacy Commands
sane_runner and sane_view are deprecated aliases for
sane workflow and sane view. Their existing arguments remain valid;
only the command prefix changes when migrating. The legacy commands print a
deprecation notice to standard error.