filtrix-cli

Agent-first command-line interface to FILTRIX — historical trading-pattern backtesting.

Install

pipx install filtrix-cli      # or: uvx filtrix-cli ...

Authenticate

export FILTRIX_API_KEY=flt_your_key      # for backtests/screens/ticker/account
filtrix auth login                       # for managing API keys (stores a JWT)

Sign up (terminal)

filtrix auth register --email you@example.com --accept-tos
# FILTRIX emails a 6-digit code; paste it when prompted; you're logged in.

Examples

filtrix backtest --filter "gap_gup>=50" --filter "price_price<5"
filtrix screen --filter "gap_gup>=50" --limit 20
filtrix --json screen --filter "gap_gup>=50"     # force JSON in a terminal
filtrix ticker NVDA
filtrix filters --search gap
filtrix account
filtrix keys create --name laptop
filtrix llms          # machine-readable usage guide for AI agents

Output & scripting

Output is human-readable in a terminal and JSON when piped or with the global --json flag. Global flags (--json, --quiet, --profile, --api-key, --base-url) go BEFORE the subcommand. Exit codes: 0 ok, 2 usage, 3 not-found, 4 auth, 5 rate-limited, 6 network, 1 server.

Configuration

Settings resolve in order: CLI flag > environment variable > config file (filtrix config path shows the location). Use --profile NAME for multiple environments. Credentials (API key / JWT) are stored in cleartext in this TOML file (best-effort chmod 600 on POSIX) — treat it like an SSH key.