Skip to main content

Install and use the Signaliz CLI

Run Signaliz products from a terminal, files, and automation.

Written by Josh Whitfield

Install and use the Signaliz CLI

Install the CLI with Node.js and authenticate it to your workspace:

npm install -g @signaliz/cli
signaliz auth login
signaliz auth status

Common commands

signaliz signals-first "companies that just got funded" --limit 25
signaliz company-signals --domain example.com
signaliz awareness add --domain example.com --schedule weekly
signaliz signal-to-copy --company-domain example.com --campaign-offer "pipeline intelligence"

Add --json for machine-readable output and --dry-run to preview supported work without provider calls or spend. Use --no-wait when you want a durable receipt immediately, then resume with the returned run or job ID.

Process files

The row-oriented products accept JSON or JSONL input with up to 5,000 records. JSONL is preferable for large streams:

signaliz company-signals --input companies.jsonl --jsonl --omit-raw

The CLI preserves input order and exits non-zero when any result fails, while still writing the complete machine output. Save the final summary, job ID, and idempotency key.

Run signaliz --help, signaliz tools, or a command's help for the current flags. Configuration is stored with restricted file permissions and can be overridden by SIGNALIZ_API_KEY and workspace environment settings.

Did this answer your question?