Skip to content

CLI usage

The CLI is a JSON-only adapter that calls CoreServiceBoundary. Logs go to stderr; stdout contains a machine-readable envelope.

Identity and common fields

Use argus auth login for interactive OAuth or an approved machine API key for unattended work. Data requests accept structured identity, purpose, as_of, and output-format fields. They do not accept free-form execution instructions.

Capability discovery

Run argus tool-registry for the authoritative inventory and structured major-version migration manifest. Generated parameter and transport mappings are in Generated Interface Contracts. Inspect argus <command> --help for executable options and defaults. All business commands accept --requires-redistribution and propagate it to core license checks.

For CLI bindings, apply parameter_aliases, then replace underscores with hyphens. Array parameters are comma-separated strings. For example, normalized field_names maps to --fields revenue,net_income; preflight range_start and range_end map to --from-time and --to-time.

JSON-string parameters ending in -json must encode the declared shape: filters, sort, facts, nodes, and observations are JSON arrays; limits is a JSON object. Use [] for an empty array and {} for an empty object. null is not an empty collection. A supplied invalid date or structured value returns success=false with error.error_code=invalid_argument on stdout and exit code 2, including in remote mode. Exit code 1 indicates an authentication, governance, or remote request failure. Shell syntax and missing options are reported by the CLI parser on stderr.

For a real first request, install the official release and complete OAuth as described in Getting started:

argus auth login
argus --base-url https://api.argusfa.com entity-resolve --identifier-type lei --identifier-value HWUPKR0MPOU8FGXBT394

The examples below show parameter syntax only. Their example identifiers and dates do not establish production coverage. Discover a real company/security identifier and check the source's actual historical window before replacing them; an empty or unavailable response is not a successful data request.

argus filing-evidence-extract --company-id company:example-inc --query-terms revenue,annual
argus market-session-fact-package --market US --session us_regular_close --session-date 2026-06-16 --symbols EXM,ACME
argus point-in-time-dataset-export --as-of 2026-06-16T20:00:00Z

Only read-only fact, evidence, catalog, stream, governance-metadata, and export commands are public. Universe and filters are supplied by the caller. The CLI has no question answering, narrative generation, user-list mutation, performance analysis, strategy, order, account, or AI-agent-orchestration commands.