01 / OVERVIEW
Only commands backed by the current API contract.
The CLI calls the official TypeScript SDK. It currently supports Reality tokenized-equity spot listings, asynchronous company research jobs, and research-job webhooks. Service-side authorization, tenant ownership, quota checks, and provider terms remain authoritative.
It does not expose account or key management, strategy or trading operations, generic REST passthrough, or MCP internals.
02 / QUICKSTART
Build the source and authenticate.
Install the published CLI from npm, or clone the mother repository to build against the checked-in SDK source.
tidelight auth login
tidelight research start NVDA --wait --timeout-ms 120000
tidelight research get <job-id> --json
tidelight research cancel <job-id>Credential storage uses the operating-system keychain. Linux requires Secret Service. If no supported keychain is available, provide TIDELIGHT_API_KEY to the current process; the CLI never saves a plaintext config file.
03 / COMMANDS
Supported market, research, and webhook workflows.
market instrumentsPaginated list of supported tokenized-equity spot instruments; source labels are preserved and provider terms errors are surfaced.research start / get / wait / cancelCreate an idempotent company research job, retrieve a result, poll to a bounded terminal state, or explicitly request cancellation.webhooks list / create / update / disable / deliveriesManage supported research-job webhook events through the official SDK; signing secrets are returned once.--jsonWrite the API response shape to stdout for scripts and automation.04 / SECURITY & TRUST
Credential handling belongs to trusted local storage.
- Interactive key input does not echo the key; saved credentials go to the OS keychain.
TIDELIGHT_API_KEYis process-scoped and takes precedence over keychain data.- Only supported command arguments are accepted; arbitrary URL or HTTP passthrough is not implemented.
- Webhook signing secrets are shown once with an explicit warning and are never stored by the CLI.
- API errors show the request ID and bounded service message without returning raw provider response bodies.
Use project keys with the narrowest required scopes. Market data can be unavailable when redistribution terms are not configured; the CLI does not substitute another data source.
05 / EXAMPLES
Honest automation output.
Market commands display only API-returned instruments with their underlying ticker, instrument kind, last price, provider source, pagination cursor, and request ID. Research job status and outputs remain limited by current service behavior and the caller’s credential scopes.
RELEASE / LIVE REGISTRY
Published release details
Version, installation, registry status, and archive details below are refreshed from the public registry.
Official Tidelight command line interface
npm install @tidelight/cli@0.1.1