Quicknode CLI

Overview​

The Quicknode CLI is the qn command-line tool for working with Quicknode product APIs from a terminal, shell script, or CI job.

Install​

Install qn with the recommended command for your system. The install tabs are selected from your browser user agent when possible, and you can choose any install path manually.

brew install quicknode/tap/qn

After installation, check the version:

qn --version

Then authenticate and verify access:

qn auth login
qn auth whoami

Run your first read commands:

qn chain list
qn endpoint list
qn endpoint list --format json

Product coverage​

Use the CLI to inspect and manage:

• Admin API: Endpoints, teams, usage, billing, logs, metrics, endpoint security, rate limits, and account tags.
• Streams: Stream listing, creation, inspection, lifecycle actions, and filter testing.
• Webhooks: Webhook listing, template creation, inspection, lifecycle actions, and enabled counts.
• Key-Value Store: Sets and lists for state, watchlists, cursors, filters, and small lookup tables.

When to use the CLI​

Use the CLI when the terminal is the fastest interface for the job.

Common workflows include:

• List endpoints, URLs, logs, and metrics while debugging.
• Check account usage, billing records, chains, teams, and tags.
• Create or inspect Streams and Webhooks during development.
• Read and update Key-Value Store data from scripts.
• Run repeatable CI checks with explicit credentials and structured output.

For application code, use the Quicknode SDK or the product REST APIs directly.

Authenticate​

Create an API key in the Quicknode dashboard, then run:

qn auth login
qn auth whoami

qn resolves credentials in this order:

1. --api-key <KEY>
2. --config-file <PATH>
3. ~/.config/qn/config.toml

The CLI does not read API keys from environment variables. For scripts and CI, pass --api-key from a secret store or write a config file outside your repository and pass --config-file.

For one command, pass the key explicitly:

qn --api-key YOUR_API_KEY endpoint list --format json

For CI, write a config file outside the repository and point the CLI at it:

mkdir -p "$RUNNER_TEMP/qn"
printf '[api]\nkey = "%s"\n' "$QUICKNODE_API_KEY" > "$RUNNER_TEMP/qn/config.toml"

qn --config-file "$RUNNER_TEMP/qn/config.toml" endpoint list --format json

Output​

Set the output format with --format or -o.