quantcentral-cli 0.1.0

Quantcentral.ai command-line client (qc) — manage backtest runs, results, and credentials from the terminal.

quantcentral-cli

Command-line client for the Quantcentral.ai platform — manage backtest runs, results, and credentials from the terminal.

Part of the Quantcentral.ai ecosystem.

Install

pip install quantcentral-cli

Requires Python 3.12+. Provides a single executable: qc.

Quickstart

# 1. Point qc at your control-api deployment (default: http://localhost:8080).
qc auth set-url https://api.quantcentral.ai

# 2. Save your bearer token. Issued by control-api / SSO.
qc auth login                         # prompts (hidden input)

# 3. Verify.
qc auth status

# 4. Submit a run.
qc run create ./run-bundle.json --start

# 5. Watch.
qc run list
qc run show <run-id>

# 6. Pull results.
qc run result <run-id> --output result.json

Commands

Command	Purpose
qc auth login	Store the bearer token (JWT) issued by control-api.
qc auth logout	Remove the stored token.
qc auth status	Show the configured API URL and the JWT subject (no signature check).
qc auth set-url <url>	Persist the control-api URL.
qc run create <bundle.json>	POST a run bundle to /v1/runs. Use --start to start immediately.
qc run start <run-id>	Start a created run.
qc run cancel <run-id>	Cancel a running run.
qc run list	List recent runs (Rich table).
qc run show <run-id>	Print run metadata as JSON.
qc run result <run-id>	Fetch the result JSON; --output PATH writes to file.

Configuration

Path / env	Purpose
~/.config/quantcentral/token	Bearer token (mode 600).
~/.config/quantcentral/config.toml	[api] url = "..."
$QC_CONFIG_DIR	Override config directory (useful for tests / CI).
$QC_API_URL	Override API base URL (takes precedence over disk).
$QC_TOKEN	Override bearer token (takes precedence over disk).

Roadmap

v0.1.0 ships the auth and run subcommand families — enough to drive a full backtest lifecycle against control-api. Future versions are planned to add:

Subcommand	Status
qc strategy scaffold/validate/push	v0.2 — scaffolds strategies using quantcentral-sdk's StrategyBase.
qc optim sweep/show	v0.2 — parameter optimization sweeps.
qc feed list/test	v0.3 — data feed inspection.
qc broker list/test	v0.3 — broker connectivity check.
qc mcp inspect	v0.3 — local MCP tool introspection.

License

Apache-2.0 — see LICENSE for details. Attribution requirements in NOTICE.

Development

git clone [e-mail]:QuantCentral-ai/quantcentral-cli.git
cd quantcentral-cli
python -m venv venv && source venv/bin/activate
pip install -e ".[dev]"
pytest

Tracking: https://github.com/QuantCentral-ai/quantcentral-planning