Command-line reference

Fast single-session commands fast validate, fast explain and fast run accept --process-count to override analysis execution.process_count. fast batch --process-count overrides its batch-root count. One fast session can contain multiple ASC/BLF volumes and publishes one summary. Workers read, decode and evaluate current-message contributions; the main process accumulates in order. See fast configuration.

Use terminal commands to load and check a configuration, run an analysis, and publish results. Put the analysis definitions in the configuration file; put options such as an output directory or backend override after the appropriate command.

Run the basic parallel configuration

Download the complete examples directory and open a terminal there. These steps inherit the continuous-volume example's explicit execution.process_count: 4:

python -m chronaxis validate continuous-parallel.yaml
python -m chronaxis explain continuous-parallel.yaml --format json
python -m chronaxis run continuous-parallel.yaml --output result-continuous

validate checks configuration, explain describes execution, and run reads and analyzes the logs. With two files, source_execution[].file_count and read_process_limit are both 2; four is only the limit. Use manifest in the completion summary to locate this run's actual output files. The integral is 38 J; see the worked result.

Ordinary explain reports read_process_limit as a bound derived from configuration and source type, not the number of workers already started. For one ASC, configured limit 4 and default concatenate, reading takes place in the current process and read_process_limit is 0; two files with that limit yield 2. Ordinary time_order uses one file child even at a configured limit of 1. Fast worker_process_limit follows its own scheduling rules and is 0 for inline execution. These are plan facts; actual PIDs can only be established during execution.

Append --process-count 2 for a temporary override without editing the configuration. A single CSV, memory or multi-source plan uses process_count: 1. Independent tasks use the batch-root count; see execution settings.

Commands

Replace PLAN and BATCH with paths. An installed package also provides the chronaxis command. Success returns 0 and cancellation returns 130. Failure codes 1 and 2 depend on the command and stage, as explained in Exit codes and failure stages; “file error” alone does not determine the code. Use python -m chronaxis --help and each subcommand's --help. The full implementation is in the CLI reference (Chinese implementation reference).

Ordinary run, validate and explain accept --process-count to override file-reading/decoding workers. The same option for batch run limits independent analysis workers. See continuous multiprocessing.

For fast run, execution.process_count controls session workers; fast batch uses the batch-root count. Both accept --process-count overrides, as do fast validate/explain. --total is a flag, omitted by default; the report explains any unavailable total. For guide, --language defaults to zh; en selects the English README, and an optional ZIP contains both languages.

For config init, convert, and resolve options and file-protection rules, see Configuration tools. For direct reading and optional guide export, see AI guide.

Exit codes and failure stages

The exit code tells you whether a command succeeded; diagnostics and batch reports explain why it failed. The same file problem may return different codes through different commands. Account for the command when writing a shell script.

Examples:

• A missing configuration returns 1 from ordinary validate and 2 from fast validate. A missing DBC follows the same distinction.
• An explicitly configured but missing missing.asc is not read by static validate/explain, so those commands may return 0. The actual run reads it and returns 1. Static success does not prove that the log can be read.
• An ordinary batch using jobs loads each referenced analysis configuration after its worker starts. If a child configuration references an empty directory or an unmatched glob, that task is marked failed, the batch returns 1, and a batch task report is available.
• An ordinary batch using template/inputs expands the template and constructs each child plan while loading the batch configuration. For example, a valid template may have two CSV sources, primary and auxiliary. With source: primary, only primary is replaced by inputs. If the retained auxiliary source references an empty directory or an unmatched glob, loading returns 2: no task has started and no task report exists. This is not limited to expansion errors in batch inputs itself. See load_batch_plan for the loading contract.
• fast batch checks its supported CAN child configurations before dispatch. Preparation errors such as empty directories or unmatched globs return 2, without starting tasks or producing task reports. It does not support the two-CSV template above.
• If the output path is an existing ordinary file, ordinary run, ordinary batch run, and fast run return 1; fast batch returns 2. A file error while writing the final fast batch report can also return 2 after child tasks have succeeded. Their completed outputs remain available.

On a nonzero exit, retain stderr and inspect any task reports already written. A nonzero exit does not mean that all published results were rolled back. Failed or cancelled batches must not count unfinished tasks as successes.

See several configuration errors at once

Run chronaxis validate plan.yaml --format json. When fields can be parsed, it lists independently detectable errors together, such as invalid backend, batch_rows and table format. Each diagnostic retains available source, path, line, column, code, message and hint. JSON uses an errors array even for one error; the former singular error field is no longer returned. Text mode numbers the errors.

Repair malformed YAML/JSON syntax first. An invalid source or signal can prevent dependent checks; blocked_checks explains those checks instead of inventing values. Run validation again after repairs. A configuration error prevents run from starting analysis. Static checks may read DBC metadata when configuration defaults require it, but do not read business message contents.

The run summary returns the actual manifest path; batch run returns the actual report path. Output filenames receive a timestamp suffix; see result publication.

AI guide

chronaxis guide prints the absolute Chinese README path; chronaxis guide --language en selects English. Neither writes files. Optional --output new-file.zip saves a complete bilingual copy; its parent must exist and the target must be new. See AI guide.