Skip to content

enumeray analysis logs

Read retained log pages or follow live diagnostics for an analysis directory.

Use when: Your analysis has an accepted run identity and you need logs without extracting its run ID.

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 analysis logs analysis --limit 50
enumeray analysis logs analysis --follow --interval 2 --deadline 3600

Status, wait, cancellation and transfers remain available during follow. Retained-page reads remain independent. Atomic checkpoints follow flushed output; a crash before persistence can replay entries. Keep the checkpoint and stable lock file private. For an imported or initialized operation with no accepted identity, explicitly reconcile with analysis submit analysis first; log observation never submits work.

Input Meaning and use
<DIRECTORY> Existing private analysis directory with an accepted run identity from a receipt or attachment.
--limit <LIMIT> Maximum entries on one retained page, from 1 through 100; the API default is 50. Incompatible with --follow.
--cursor <CURSOR> Opaque next-page or resume-later cursor from a retained log response. Pass unchanged. Incompatible with --follow, which resumes the automatic checkpoint.
--follow Follow resumable SSE logs and drain retained logs after terminal inspection. Uses the automatic private state/logs.json checkpoint; there is no --state option. One follower is allowed per directory.
--interval <INTERVAL> Positive run inspection interval in seconds while following; default 2. Requires --follow.
--deadline <DEADLINE> Positive total observation budget in seconds while following; default 3600, including requests, reconnection and final draining. Requires --follow.
--allow-gaps Explicitly acknowledge missing retained history and continue from the service recovery cursor while preserving gap/reset evidence. Requires --follow.

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

Without --follow, reads one retained page. Follow automatically resumes private state/logs.json, checks run state independently, drains retained logs after a terminal outcome and exits 0. --json --follow emits newline-delimited {event,id,data} records and a final run record. Deadline exits 5; interruption exits 130; neither changes remote execution.

Repeat the same folder command after interruption or credential renewal for the same API/account. Review reported retention gaps, then explicitly add --allow-gaps to resume. Use analysis wait --check-outcome for scientific outcome exits.

Exact syntax, defaults and accepted values
Read retained logs or follow the accepted run using this directory's private checkpoint
Usage: enumeray analysis logs [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
--limit <LIMIT> Maximum entries on this page (1–100); omit for the API default
--cursor <CURSOR> Continuation from the preceding page; pass unchanged with the same filters
--profile <PROFILE> Named local user API/login profile; host/runner commands use explicit configuration [default: default]
--config <CONFIG> Private user profiles file; defaults to $XDG_CONFIG_HOME/enumeray/profiles.json or ~/.config/enumeray/profiles.json
--follow Follow resumable live logs, then drain retained logs after terminal inspection
--interval <INTERVAL> Run inspection interval in seconds (default 2 when following)
--json Emit user API results as JSON (NDJSON for following logs) and runtime errors on stderr; host/runner output follows its own protocol
--deadline <DEADLINE> Local observation deadline in seconds (default 3600 when following)
--timeout <TIMEOUT> User API HTTP timeout in seconds; live logs use it for read inactivity. Does not limit execution time [default: 60]
--allow-gaps Explicitly acknowledge missing retained history and continue from its recovery cursor
-h, --help Print help

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