CLI reference¶
Generated from the command registry. Every command accepts --json.
sqy version¶
Show framework, Python and platform versions.
sqy doctor¶
Check the environment, dependencies, cache and credentials.
sqy commands¶
List commands, reason codes and exit codes.
sqy schema¶
List bundled JSON schemas, or print one.
| Option | Meaning |
|---|---|
name |
schema name (omit to list them) |
sqy explain¶
Explain a reason code and how to resolve it.
| Option | Meaning |
|---|---|
code |
reason code, e.g. HOLDOUT_REUSED |
sqy init¶
Create a new strategy project.
| Option | Meaning |
|---|---|
path |
new project directory |
--upgrade-agents-md |
refresh the framework-owned blocks of an existing project's AGENTS.md |
--project |
project directory for --upgrade-agents-md |
--demo |
use synthetic data (no credentials needed) |
--lab |
a multi-family strategy lab (per-family ledgers) |
--kind |
starter: equity trend, options wheel, or factor demo (requires --demo) (one of equity, options, factor) |
--package |
Python package name for strategies (default: from the directory name) |
sqy check¶
Run conformance, determinism and look-ahead checks.
| Option | Meaning |
|---|---|
--strategy |
check only this strategy id |
--factor |
check one project module defining a @factor function |
--factor-id |
check a factor id registered in signalquarry.toml |
--params-json |
JSON object of factor parameters |
--parity |
also replay 60 sessions through the paper kernel and a fake venue; must match the backtest |
--project |
project directory (default: search upwards from cwd) |
sqy factor¶
List factors or calculate unverified descriptive diagnostics.
sqy factor ls¶
List explicitly registered project factors and hashes.
| Option | Meaning |
|---|---|
--project |
project directory (default: search upwards) |
sqy factor evaluate¶
Compute descriptive, unverified diagnostics from selected local manifests.
| Option | Meaning |
|---|---|
--factor |
registered factor ID (required) |
--dataset-id |
locally recorded dataset manifest ID |
--universe-manifest |
dated universe build manifest path; repeat for each decision session |
--synthetic |
use an offline synthetic panel without manifests |
--symbols |
synthetic panel symbol count (default: 200) |
--seed |
synthetic panel random seed (default: 7) |
--planted-ic |
synthetic signal loading (default: 0.05) |
--project |
project directory (default: search upwards) |
sqy factor report¶
Evaluate a factor and write a descriptive Markdown report with SVG charts.
| Option | Meaning |
|---|---|
--factor |
registered factor ID (required) |
--dataset-id |
locally recorded dataset manifest ID |
--universe-manifest |
dated universe build manifest path; repeat for each decision session |
--synthetic |
use an offline synthetic panel without manifests |
--symbols |
synthetic panel symbol count (default: 200) |
--seed |
synthetic panel random seed (default: 7) |
--planted-ic |
synthetic signal loading (default: 0.05) |
--project |
project directory (default: search upwards) |
sqy factor holdout seal¶
Explicit human command: fix a family's factor holdout once; never open it.
| Option | Meaning |
|---|---|
--family |
registered factor family (required) |
--dataset-id |
locally recorded dataset manifest ID (required) |
--project |
project directory (default: search upwards) |
sqy factor holdout status¶
Read factor seals and ledger-derived trial usage.
| Option | Meaning |
|---|---|
--family |
show only this factor family |
--project |
project directory (default: search upwards) |
sqy data¶
Fetch, verify and list recorded market data.
sqy data quality¶
Inspect dataset completeness and consistency.
| Option | Meaning |
|---|---|
--strategy |
assess the dataset and history available to this strategy |
--dataset-id |
assess every symbol in this recorded dataset |
--project |
project directory (default: search upwards from cwd) |
sqy data fetch¶
Download daily bars and corporate actions and record a manifest.
| Option | Meaning |
|---|---|
--strategy |
fetch the symbols (and benchmark) of this strategy |
--symbols |
comma-separated extra symbols |
--start |
first date (default 2016-01-01) |
--end |
last date (default yesterday) |
--feed |
default: the strategy's feed, else sip (one of sip, iex) |
--project |
project directory (default: search upwards from cwd) |
sqy data capture-actions¶
Record all corporate-action categories in the private cache.
| Option | Meaning |
|---|---|
--symbols |
comma-separated uppercase symbols (required) |
--start |
first process date (required) |
--end |
last process date (required) |
--project |
project directory (default: search upwards from cwd) |
sqy data probe¶
Check provider coverage: expired option contracts and their bars.
| Option | Meaning |
|---|---|
what |
what to probe (one of options-coverage) |
--underlying |
underlying symbol |
--month |
expiration month to probe, YYYY-MM (required) |
--project |
project directory (default: search upwards from cwd) |
sqy data record¶
Record today's option chain for an underlying (raw pages cached, hash-only record).
| Option | Meaning |
|---|---|
what |
what to record (one of options) |
--underlying |
underlying symbol, e.g. QQQ (required) |
--max-dte |
latest expiration, in days from today |
--width |
strike window around spot, as a fraction |
--project |
project directory (default: search upwards from cwd) |
sqy data verify¶
Re-hash cached pages against every manifest.
| Option | Meaning |
|---|---|
--project |
project directory (default: search upwards from cwd) |
sqy data ls¶
List recorded datasets.
| Option | Meaning |
|---|---|
--project |
project directory (default: search upwards from cwd) |
sqy universe¶
Build and verify point-in-time common-stock universes.
sqy universe snapshot¶
Capture the full current Alpaca US-equity asset list.
| Option | Meaning |
|---|---|
--project |
project directory (default: search upwards from cwd) |
sqy universe verify¶
Verify hashed asset snapshots against cached raw pages.
| Option | Meaning |
|---|---|
--project |
project directory (default: search upwards from cwd) |
sqy universe as-of¶
Find a verified snapshot known by a UTC cutoff.
| Option | Meaning |
|---|---|
--known-at |
timezone-aware decision cutoff (ISO 8601); older than 31 days is unavailable (required) |
--project |
project directory (default: search upwards from cwd) |
sqy universe build¶
Build one dated common-stock universe from verified as-of inputs.
| Option | Meaning |
|---|---|
--session |
decision session (YYYY-MM-DD) (required) |
--known-at |
timezone-aware cutoff before the decision session (ISO 8601) (required) |
--dataset-id |
verified Alpaca dataset manifest ID (required) |
--classification-file |
dated JSON security-master snapshot keyed by stable asset UUID (required) |
--minimum-price |
minimum prior-session close in USD (required) |
--minimum-listing-age-days |
minimum listing age at the decision session (required) |
--minimum-dollar-volume-percentile |
minimum 20-session median dollar-volume percentile (0-100) (required) |
--project |
project directory (default: search upwards from cwd) |
sqy spec¶
Freeze a strategy configuration (spec freeze).
sqy spec freeze¶
Freeze the configuration and seal the family's holdout.
| Option | Meaning |
|---|---|
--strategy |
strategy id from strategy.yaml (required) |
--project |
project directory (default: search upwards from the current directory) |
sqy evaluate¶
Walk-forward, stress and holdout gates; sets the claim level.
| Option | Meaning |
|---|---|
--strategy |
strategy id from strategy.yaml (required) |
--no-stress |
skip the cost and delay stress reruns |
--holdout |
open the sealed holdout (once per family; needs G1-G3) |
--project |
project directory (default: search upwards from the current directory) |
sqy trials¶
List trials or (humans only) extend a family's budget.
sqy trials ls¶
List recorded trials.
| Option | Meaning |
|---|---|
--family |
strategy family |
--project |
project directory (default: search upwards from the current directory) |
sqy trials show¶
Show entries by sequence number or configuration-hash prefix.
| Option | Meaning |
|---|---|
key |
sequence number or configuration-hash prefix |
--project |
project directory (default: search upwards from the current directory) |
sqy trials extend¶
HUMAN ONLY: add 10 trials to a family's budget.
| Option | Meaning |
|---|---|
--family |
strategy family (required) |
--reason |
why; recorded in the evidence log (required) |
--project |
project directory (default: search upwards from the current directory) |
sqy holdout¶
Seal a family's holdout early, or show seals and openings.
sqy holdout status¶
Show each family's holdout seal and opening.
| Option | Meaning |
|---|---|
--project |
project directory (default: search upwards from the current directory) |
sqy holdout seal¶
Seal the strategy family's holdout now, before exploring.
| Option | Meaning |
|---|---|
--strategy |
strategy id from strategy.yaml (required) |
--project |
project directory (default: search upwards from the current directory) |
sqy sweep¶
Backtest a parameter grid (each point on real data is a trial); reports PBO.
| Option | Meaning |
|---|---|
--strategy |
strategy id from strategy.yaml (required) |
--param |
NAME=V1,V2,… (repeatable) (required) |
--summary-only |
keep result.json and equity curves per point; leave out fills and decisions |
--jobs |
simulate points in N worker processes (default 1); what is recorded does not depend on N |
--project |
project directory (default: search upwards from the current directory) |
sqy runs¶
List, show and compare backtest runs.
sqy runs ls¶
List recent backtest runs, newest first.
| Option | Meaning |
|---|---|
--strategy |
only runs of this strategy id |
--limit |
how many runs to list (default 20) |
--project |
project directory (default: search upwards from the current directory) |
sqy runs show¶
Show one run's result document and artifacts.
| Option | Meaning |
|---|---|
run |
run id |
--project |
project directory (default: search upwards from the current directory) |
sqy runs compare¶
Compare two or more runs against the first; writes comparison.md.
| Option | Meaning |
|---|---|
runs |
run ids; the first is the reference |
--project |
project directory (default: search upwards from the current directory) |
sqy study¶
Declared comparisons: a subject, baselines and bounded variants under one rule.
sqy study init¶
Scaffold studies/ID/study.yaml for a strategy.
| Option | Meaning |
|---|---|
--strategy |
the subject strategy id (required) |
--id |
id of the new study (required) |
--metric |
the comparison metric, e.g. max_drawdown (with --direction) |
--direction |
higher or lower (with --metric) |
--project |
project directory (default: search upwards from the current directory) |
sqy study check¶
Validate a study, list its arms and the trials it would record; runs nothing.
| Option | Meaning |
|---|---|
--study |
study id (required) |
--project |
project directory (default: search upwards from the current directory) |
sqy study run¶
Run every arm on one dataset and window and compare them by the declared rule.
| Option | Meaning |
|---|---|
--study |
study id (required) |
--rerun |
recompute arms that already have a run and require the same ledger hash |
--jobs |
simulate arms in N worker processes (default 1); what is recorded does not depend on N |
--project |
project directory (default: search upwards from the current directory) |
sqy study ls¶
List studies and the verdict of each one's latest run.
| Option | Meaning |
|---|---|
--project |
project directory (default: search upwards from the current directory) |
sqy study show¶
Show the latest recorded result of a study.
| Option | Meaning |
|---|---|
--study |
study id (required) |
--project |
project directory (default: search upwards from the current directory) |
sqy backtest¶
Backtest a strategy and write run artifacts.
| Option | Meaning |
|---|---|
--strategy |
strategy id from strategy.yaml (required) |
--start |
first session (YYYY-MM-DD) |
--end |
last session (YYYY-MM-DD) |
--param |
NAME=VALUE parameter override for this run only (repeatable); strategy.yaml is not changed |
--label |
short name stored with the run |
--project |
project directory (default: search upwards from cwd) |
sqy evidence¶
Verify evidence ledgers, journals and bundles; export a family's evidence bundle.
sqy evidence verify¶
Verify evidence ledgers and paper journals, or an exported bundle (--bundle).
| Option | Meaning |
|---|---|
--base |
git ref; fail if any log changed other than by appending since it |
--bundle |
verify this exported evidence bundle directory instead |
--max-tier |
highest tier the bundle may carry (one of public, nda) |
--project |
project directory (default: search upwards from the current directory) |
sqy evidence export¶
Export a family's evidence bundle under its publication policy.
| Option | Meaning |
|---|---|
--family |
strategy family (required) |
--tier |
public (showcase) or nda (data room) (one of public, nda) |
--out |
output directory (default: .signalquarry/exports/...) |
--project |
project directory (default: search upwards from the current directory) |
sqy commit¶
Salted commitments to frozen strategies and journal heads (OpenTimestamps).
sqy commit create¶
Commit to a frozen strategy (salted) or to a paper journal head.
| Option | Meaning |
|---|---|
--strategy |
strategy id from strategy.yaml (required) |
--alias |
commit to this paper deployment's journal head instead |
--project |
project directory (default: search upwards from the current directory) |
sqy commit reveal¶
Write the private opening of a spec commitment (NDA only).
| Option | Meaning |
|---|---|
--id |
commitment id (required) |
--out |
where to write the opening (mode 0600) (required) |
--project |
project directory (default: search upwards from the current directory) |
sqy commit verify¶
Check an opening against a commitment record.
| Option | Meaning |
|---|---|
--record |
commitment record JSON (required) |
--reveal |
opening JSON from sqy commit reveal (required) |
--project |
project directory (default: search upwards from the current directory) |
sqy perf¶
Paper performance snapshots: private captures, or a public feed (live_feed: allow).
sqy perf publish¶
Capture and write ALIAS/latest.json (signalquarry-public-performance/v1).
| Option | Meaning |
|---|---|
--alias |
paper deployment alias (required) |
--out |
feed directory, e.g. site/public/feeds/paper (required) |
--project |
project directory (default: search upwards from the current directory) |
sqy perf capture¶
Record a private, hash-chained snapshot under paper/ALIAS/captures/.
| Option | Meaning |
|---|---|
--alias |
paper deployment alias (required) |
--project |
project directory (default: search upwards from the current directory) |
sqy docs¶
Print llms.txt (or --full: every guide, the CLI reference and reason codes) for agents.
| Option | Meaning |
|---|---|
--llms |
llms.txt format (the default) |
--full |
llms-full.txt: all documentation |
sqy report¶
Render the latest backtest and evaluation as report.md and equity.svg.
| Option | Meaning |
|---|---|
--strategy |
strategy id from strategy.yaml (required) |
--run |
backtest run id (default: the latest) |
--project |
project directory (default: search upwards from the current directory) |
sqy diagnose¶
Write descriptive diagnostics for a recorded backtest run.
| Option | Meaning |
|---|---|
--strategy |
strategy id of the recorded run (required) |
--run |
backtest run id (default: the latest for this strategy) |
--exposure |
passive reference symbol (repeatable, up to eight) |
--project |
project directory (default: search upwards from cwd) |
sqy paper¶
Alpaca paper forward tests: preflight, dry-run, run-once, status, halt.
sqy paper preflight¶
Read-only readiness checks for a deployment.
| Option | Meaning |
|---|---|
--alias |
deployment alias (the ALIAS in paper/ALIAS.paper.yaml) (required) |
--project |
project directory (default: search upwards from the current directory) |
sqy paper dry-run¶
Decide and size the next session without submitting anything.
| Option | Meaning |
|---|---|
--alias |
deployment alias (the ALIAS in paper/ALIAS.paper.yaml) (required) |
--project |
project directory (default: search upwards from the current directory) |
sqy paper arm¶
HUMAN ONLY: allow a deployment to submit paper orders (interactive confirmation).
| Option | Meaning |
|---|---|
--alias |
deployment alias (the ALIAS in paper/ALIAS.paper.yaml) (required) |
--project |
project directory (default: search upwards from the current directory) |
--reason |
recorded in the journal (required) |
sqy paper run-once¶
Reconcile, decide and submit the current session's orders (idempotent).
| Option | Meaning |
|---|---|
--alias |
deployment alias (the ALIAS in paper/ALIAS.paper.yaml) (required) |
--project |
project directory (default: search upwards from the current directory) |
--notify-command |
absolute executable path; called on a non-zero run-once exit with no credential environment |
sqy paper status¶
Show the journal state: armed/halted, sessions, pending orders.
| Option | Meaning |
|---|---|
--alias |
deployment alias (the ALIAS in paper/ALIAS.paper.yaml) (required) |
--project |
project directory (default: search upwards from the current directory) |
sqy paper capture-activities¶
Read-only private capture of paper account activities by creation time.
| Option | Meaning |
|---|---|
--alias |
deployment alias (the ALIAS in paper/ALIAS.paper.yaml) (required) |
--project |
project directory (default: search upwards from the current directory) |
--created-after |
activity creation time with UTC offset (required) |
--created-until |
later creation time with UTC offset (required) |
sqy paper verify-activities¶
Re-hash a private paper activity capture without contacting Alpaca.
| Option | Meaning |
|---|---|
--alias |
deployment alias (the ALIAS in paper/ALIAS.paper.yaml) (required) |
--project |
project directory (default: search upwards from the current directory) |
--capture |
private capture hash (required) |
sqy paper observe-activities¶
Normalize a private activity capture without interpreting economic terms.
| Option | Meaning |
|---|---|
--alias |
deployment alias (the ALIAS in paper/ALIAS.paper.yaml) (required) |
--project |
project directory (default: search upwards from the current directory) |
--capture |
private capture hash (required) |
sqy paper verify-observations¶
Rebuild private activity observations from captured pages offline.
| Option | Meaning |
|---|---|
--alias |
deployment alias (the ALIAS in paper/ALIAS.paper.yaml) (required) |
--project |
project directory (default: search upwards from the current directory) |
--observation |
private observation hash (required) |
sqy paper compare-observations¶
Compare private observations from the same account and creation window.
| Option | Meaning |
|---|---|
--alias |
deployment alias (the ALIAS in paper/ALIAS.paper.yaml) (required) |
--project |
project directory (default: search upwards from the current directory) |
--left |
earlier private observation hash (required) |
--right |
later private observation hash (required) |
sqy paper reconcile¶
Finalize journaled orders and check positions against the broker.
| Option | Meaning |
|---|---|
--alias |
deployment alias (the ALIAS in paper/ALIAS.paper.yaml) (required) |
--project |
project directory (default: search upwards from the current directory) |
sqy paper halt¶
Stop a deployment and cancel its open orders; a human re-arms.
| Option | Meaning |
|---|---|
--alias |
deployment alias (the ALIAS in paper/ALIAS.paper.yaml) (required) |
--project |
project directory (default: search upwards from the current directory) |
--reason |
recorded in the journal (required) |
sqy paper drift¶
Replay sessions against the engine, measure fill slippage, apply model costs; gate G5.
| Option | Meaning |
|---|---|
--alias |
deployment alias (the ALIAS in paper/ALIAS.paper.yaml) (required) |
--project |
project directory (default: search upwards from the current directory) |
sqy paper run¶
Run run-once until done, retrying while busy or unavailable (for a service manager).
| Option | Meaning |
|---|---|
--alias |
deployment alias (the ALIAS in paper/ALIAS.paper.yaml) (required) |
--project |
project directory (default: search upwards from the current directory) |
--interval |
seconds between retries |
--max-minutes |
give up after this long |
sqy paper backup¶
Write a tar.gz of the journal and arm token with a hash manifest.
| Option | Meaning |
|---|---|
--alias |
deployment alias (the ALIAS in paper/ALIAS.paper.yaml) (required) |
--project |
project directory (default: search upwards from the current directory) |
--out |
directory (default: .signalquarry/backups/ALIAS) |
sqy paper verify-continuity¶
Check the live journal extends a backup (no rollback on the host).
| Option | Meaning |
|---|---|
--alias |
deployment alias (the ALIAS in paper/ALIAS.paper.yaml) (required) |
--project |
project directory (default: search upwards from the current directory) |
--backup |
a tar.gz written by paper backup (required) |
sqy paper schedule¶
Write scheduler templates (systemd, launchd, cron, github-actions) for review.
| Option | Meaning |
|---|---|
--alias |
deployment alias (the ALIAS in paper/ALIAS.paper.yaml) (required) |
--project |
project directory (default: search upwards from the current directory) |
--target |
scheduler to write templates for (github-actions is demo-only) (required; one of systemd, launchd, cron, github-actions) |
--notify-command |
absolute executable path; called on a non-zero run-once exit with no credential environment |