observatory run [CONFIG]

Reference · Commands · Documentation

Updated

Browse documentation
On this page

Earlier command and setup reference · Engine 18.6.0rc590 / Reader 8.11.0rc649

Definition

Reads every source, writes the result file and prints its path. --config FILE names the configuration, --out FILE the result file and --tasks ID … limits the analyses that run.

Run a checked configuration

Start with the configuration used to validate your sources. This example names the configuration and output explicitly:

observatory validate --config observatory.yaml
observatory run observatory.yaml --out out/observatory.sqlite

Stop if validation returns a non-zero exit code; run the second command only after checking the validation result. A relative --out path is resolved from the working directory. The configuration's output.directory is resolved beside the configuration file, so these two ways of choosing a destination need not point to the same folder.

Check the result

A successful run prints the result path. A blocked run writes no result file; use the exit code and error reason instead of assuming that an older file at the output path came from this attempt. See command exit codes before scheduling unattended runs.