CLI reference¶
This page summarizes the dm CLI. The full dm --help synopsis is generated by project_tools/update_cli_help.py; CI verifies that docs/cli-reference.md remains synchronized with the command output. For marketops and a-share-daily, use each command's own help, such as marketops tushare --help and a-share-daily --help.
Top-level commands¶
| Command | Purpose |
|---|---|
dm run |
Run ETL, scoring, and digest generation in sequence |
dm fetch |
Run ETL only |
dm score |
Run scoring only |
dm digest |
Render the digest only |
dm dashboard |
Build the static market-intelligence dashboard |
dm state-panel |
Build a market-state panel from public sources |
dm btc |
BTC monitoring helpers |
dm style-replica |
Generate the internal-only legacy StyleReplica report |
dm market-facts |
Build normalized market facts |
dm market-events |
Build normalized market events |
dm daily-report |
Build a validated market daily report |
dm research |
Create a private web-research draft |
dm metal-sample |
Save private timestamped metal reference samples |
dm us-briefing-preview |
Validate and preview a reviewed U.S. market briefing without sending |
Common options¶
dm run accepts --date, --force-fetch, --force-score, --degraded, --strict, and --disable-throttle. dm fetch accepts --date, --force, and --disable-throttle. dm score accepts --date, --force, and --strict. dm digest accepts --date and --degraded.
dm dashboard accepts --out, --state-panel, --snapshot-dir, and --no-payload-json. dm state-panel accepts output path, lookback period or start date, breadth controls, HTTP timeout, and minimum row count. dm style-replica accepts a positions CSV, signal date, internal user ID, --dry-run, and the required --internal-only acknowledgment.
Repeated --config files are merged in order, with later files taking precedence. --data can override the configured panel or factor-store manifest, --output-dir overrides the artifact directory, and repeated --set dotted.path=value applies configuration overrides.
Inspect current options¶
Use command help for the authoritative options and defaults:
uv run dm --help
uv run dm <command> --help
uv run marketops --help
uv run a-share-daily --help
This summary does not replace CLI help. Keep optional dependency boundaries intact: XGBoost, TuShare, DolphinDB, and Optuna should report a clear missing-extra error rather than silently changing behavior.
Read-only Agent brief¶
quant-market-brief --input <daily_report.json> --manifest <publication.json>
--expected-date <YYYY-MM-DD> emits verified public report evidence as JSON.
For news revisions also pass --previous-report <immutable-parent.json>.
See Agent report access for validation and limits.
quant-research-review --help describes the read-only two-report comparison
interface. See comparison semantics.