Skip to content

enumeray analysis wait

Wait for the run recorded in an analysis directory.

Use when: Your analysis has an accepted run identity and you want progress or script outcome checking.

Role and prerequisites: Authenticated model user with access to the resource. Install enumeray, configure the API and log in. Use an account or delegated token with the required permissions. Example IDs must be replaced with IDs from your service.

Terminal window
enumeray --json analysis wait analysis --check-outcome --interval 2 --deadline 3600 > terminal-run.json
Input Meaning and use
<DIRECTORY> Existing private analysis directory with an accepted run identity from a receipt or attachment.
--interval <INTERVAL> Positive polling interval in seconds; default 2. A larger value reduces requests while waiting for a long run.
--deadline <DEADLINE> Positive total time to wait in seconds; default 3600. Expiry stops the CLI wait while the same run continues on the service.
--check-outcome For run wait, exit 0 for succeeded, 3 for failed, 4 for cancelled or 5 for local deadline expiry. Terminal JSON stays on stdout even for exit 3/4; ordinary errors exit 1.

Every command also accepts the profile, API, JSON and timeout options.

Uses the existing run observer and returns terminal run JSON on stdout, including before exits 3/4. Default exits 0 for any terminal state; --check-outcome exits succeeded 0, failed 3, cancelled 4, deadline 5. Without --check-outcome, deadline exits 1. Ordinary errors exit 1, invalid arguments 2 and interruption 130.

Continue observing the same directory after a deadline or interruption; collect evidence after a terminal outcome.

Exact syntax, defaults and accepted values
Wait for the accepted run; a local deadline leaves execution unchanged
Usage: enumeray analysis wait [OPTIONS] <DIRECTORY>
Arguments:
<DIRECTORY> Existing private analysis directory bound to this API and account
Options:
--api <API> User API origin override; credentials never cross origins. Host/runner commands use explicit configuration
--interval <INTERVAL> Positive polling interval in seconds [default: 2]
--deadline <DEADLINE> Positive local wait budget in seconds; expiry stops observation without cancelling work [default: 3600]
--profile <PROFILE> Named local user API/login profile; host/runner commands use explicit configuration [default: default]
--check-outcome Exit 3 for failed, 4 for cancelled, or 5 for the local deadline
--config <CONFIG> Private user profiles file; defaults to $XDG_CONFIG_HOME/enumeray/profiles.json or ~/.config/enumeray/profiles.json
--json Emit user API results as JSON (NDJSON for following logs) and runtime errors on stderr; host/runner output follows its own protocol
--timeout <TIMEOUT> User API HTTP timeout in seconds; live logs use it for read inactivity. Does not limit execution time [default: 60]
-h, --help Print help

Documentation 205dcb3116ea · public sources 8c70356d340f · built .Download documentation identity.