Skip to main content

CLI Reference

Usage

airnode <command> [options]

During development:

bun airnode <command> [options]

airnode start

Start the HTTP server. Listens for requests and processes them through the pipeline.

airnode start [options]
OptionAliasDefaultDescription
--config <path>-cconfig.yamlPath to the config file
--env <path>-e.envPath to the environment file
airnode start -c config.yaml -e .env.production

Shut down gracefully with Ctrl+C (SIGINT) or SIGTERM.

airnode config validate

Validate a config file without starting the server. Checks YAML syntax, schema validation, and cross-field consistency.

airnode config validate -c <path> [options]
OptionAliasDescription
--config <path>-cPath to the config file (required)
--interpolateResolve ${VAR} references from the environment
airnode config validate -c examples/configs/complete/config.yaml
airnode config validate -c config.yaml --interpolate

airnode generate-mnemonic

Generate a new BIP-39 mnemonic phrase and display the corresponding address. Use this as AIRNODE_MNEMONIC in your .env file.

airnode generate-mnemonic

No options. Outputs the mnemonic and address.

airnode address

Derive and display the airnode address from the AIRNODE_PRIVATE_KEY environment variable. Useful for verifying which address your node will use without starting it.

airnode address

No options. Requires AIRNODE_PRIVATE_KEY in the environment.

airnode identity show

Display the DNS TXT record an operator should set to prove domain ownership via ERC-7529.

airnode identity show --domain <domain> [options]
OptionAliasDefaultDescription
--domain <domain>-d--Domain name to associate
--chain-id <id>1Chain ID for the TXT record

Requires AIRNODE_PRIVATE_KEY in the environment.

airnode identity show --domain api.coingecko.com
airnode identity show --domain api.coingecko.com --chain-id 137

airnode identity verify

Verify that a domain's DNS TXT record contains the expected airnode address(es).

airnode identity verify --address <address...> --domain <domain> [options]
OptionAliasDefaultDescription
--address <address...>-a--Airnode address(es) to verify (repeatable, comma-separated)
--domain <domain>-d--Domain name to check
--chain-id <id>1Chain ID for the TXT record
# Single address
airnode identity verify -a 0xAbC123... -d api.coingecko.com

# Multiple addresses
airnode identity verify -a 0xAbC123... -a 0xDef456... -d api.coingecko.com

Exits with code 0 when all addresses are verified, 1 if any are missing.

Environment variables

VariableDescription
AIRNODE_MNEMONICThe airnode's BIP-39 mnemonic phrase (12 words)
AIRNODE_PRIVATE_KEYThe airnode's private key (hex, with 0x prefix)
LOG_FORMATLog format: text (default) or json
LOG_LEVELLog level: debug, info (default), warn, error

Additional environment variables referenced in the config via ${VAR_NAME} are loaded automatically from the .env file by Bun.