CLI

The AIXBT CLI provides direct commands and declarative recipe workflows from your terminal.

Authentication

The CLI supports four authentication modes. Pick the one that fits your workflow.

API Key

aixbt login

Or pass the key directly:

aixbt login --api-key sk-your-key-here

Your key is stored in ~/.aixbt/config.json and used for all subsequent commands.

Purchase Pass (x402)

Buy a time-limited access pass with USDC on Base. No account needed.

aixbt login --purchase-pass 1d

Duration	Price
`1d`	$10
`1w`	$50
`4w`	$100

The pass key is stored automatically after purchase.

Pay Per Use (x402)

Add --pay-per-use to any command to pay for that single request. No stored credentials required.

aixbt signals --pay-per-use

Delayed / Free Tier

Add --delayed to any command to use the free tier. Returns data delayed by 24 hours. No authentication needed.

aixbt projects --delayed

Resolution Order

When multiple credentials are available, the CLI resolves them in this order:

Priority	Source	Example
1	`--api-key` flag	`aixbt signals --api-key sk-...`
2	`AIXBT_API_KEY` env var	`export AIXBT_API_KEY=sk-...`
3	`~/.aixbt/config.json`	Written by `aixbt login`

Commands

Command	Description
`login`	Authenticate with the AIXBT API
`logout`	Remove stored credentials
`whoami`	Show current authentication status
`projects`	Query tracked projects and momentum
`signals`	Query real-time detected signals
`clusters`	Explore signal clusters
`recipe`	Build and run analysis pipelines

Run aixbt <command> --help for usage details on any command.

Output Formats

Control output format with the --format flag.

Format	Description
`human`	Readable tables and summaries. Default for interactive use.
`json`	Raw JSON. Best for scripting and piping to other tools.
`toon`	Compressed token-optimized notation. Saves 30-60% tokens compared to JSON. Designed for agent consumption.

aixbt signals --format json
aixbt projects --format toon

Verbosity

Add -v flags to increase the detail level of results. Each level includes more data fields in the response.

Flag	Projects	Signals
(default)	Core fields: name, score, rank, price change	Basic signal fields
`-v`	Adds momentum history, market data, categories	Adds activity details
`-vv`	Expands individual signals inline
`-vvv`	All available fields, full signal activity

Environment Variables

Variable	Description
`AIXBT_API_KEY`	API key for authentication. Overrides config file.
`AIXBT_API_URL`	API base URL. Overrides config file.
`AIXBT_CONFIG`	Path to config file. Defaults to `~/.aixbt/config.json`.

Recipes are the CLI's most powerful feature: multi-step analysis pipelines defined in YAML. They chain API calls, iterate over results, sample and transform data, then yield to your agent for inference. The CLI handles pagination, rate limiting, and data assembly; the agent brings the LLM.

The YAML format is designed to be authored by agents. Generate a recipe on the fly from a natural language request, pipe it via stdin, and execute it immediately. Use recipes as part of iterative work with your agent to build a personal toolset: clone from the registry, customize with a human in the loop, or vibecode entire pipelines from scratch and refine them over time.

# Browse the registry
aixbt recipe list

# Clone one locally and customize it
aixbt recipe clone momentum-scan

# Run a recipe with parameters
aixbt recipe run momentum-scan.yaml --category defi --limit 20

# Validate without executing
aixbt recipe validate my-recipe.yaml

# Pipe a recipe via stdin
cat my-recipe.yaml | aixbt recipe run --stdin

The Recipe Specification is written to give an agent full understanding of recipe construction. See also the Agent Integration guide for the yield/resume protocol.

Installation