Skip to content

CLI options and defaults

Generated by scripts/dev/sync_docs.py from the Click registry. For what each command is for, its side effects and when to use it, see the CLI reference and the side-effect inventory. cne <command> --help prints the same options in Chinese.

cne audit

Option Default Description
--config configs/cnequity.toml Path to the config file.
--run-id — Run ID; repeat to merge evidence from these runs into one audit.
--full False Health snapshot of the whole lake (current state + freshness), not the files of a single run.
--research-start — Strictly validate the research window starting on this date (requires --full).
--quality-only False With --full: gate only on quality errors; check schedule freshness separately with status.
--research-end — End of the research window (defaults to the latest daily_bars; requires --research-start).
--research-universe all_a Historical research universe checked by --full.

cne backfill

Option Default Description
dataset — Required; positional argument
--config configs/cnequity.toml Path to the config file.
--profile default daily_bars accepts delisted: backfill only the confirmed delisting list, reusing the independent discovery evidence.
--shfe-annual-archive — Futures/options daily bars only: import offline from a local SHFE annual ZIP in a verified format.
--archive-year — Trading year covered by the annual ZIP.
--accept-partial-fields False Explicitly accept that the annual package lacks fields found only in the daily files; existing complete daily bars are not overwritten.
--archive-url — Optional: the original HTTPS URL of this ZIP on the SHFE website; written to evidence only.
--archive-downloaded-at — Optional: known original download time, ISO 8601 with time zone.
--plan False Print only sources, scope and fetch method, plus a request budget for derivatives. Fetches no data and does not write the lake.
--exchange — Derivatives only: restrict to an exchange; repeatable. INE is routed via SHF; 2018 futures also fetch INE daily files.
--refresh False Derivatives daily bars only: ignore completion receipts and the response cache and re-check the given range; does not bypass circuit breakers.
--retry-failed False Resume the sector_bars backfill (skip sectors already written in the checkpoint).
--force False Clear the sector_bars backfill checkpoint and refetch all sectors.
--start — Backfill start date (YYYY-MM-DD), covering daily_bars, minute_bars, derivatives daily bars, date/report-period advancement and sector_bars. sector_bars defaults to 400 days back; ranges beyond the source's history depth are kept as gaps, while the available range is delivered as usual with guidance for filling the rest.
--end — Backfill end date (YYYY-MM-DD, default today); with --start, bounds the historical window.
--outstanding False Repair only the keys owed by tolerated gaps; scope and window come from the debt ledger, ignoring --symbols/--start/--end. Filled keys are cleared from the ledger; keys still missing stay owed.
--symbols — Comma-separated symbols to restrict the scope: for scoped backfills of intraday, trading_status and corporate_actions, and scoped repairs of financial_statement_items, daily_bars and share_structure. trading_status records the exact scope in its checkpoint and coverage evidence; daily_bars writes this explicit scope into the backfill metadata.
--workers 1 margin_trading only: concurrency for date advancement. Each request still goes through the shared source rate limiter from the config; must be 1 for other datasets.
--margin-source — margin_trading only: source to use for this backfill, without changing the config file or source rate limits.
--payment-date-repair False corporate_actions only: apply reviewed issuer announcements first, then match actual payment dates with Baostock; payment dates earlier than the ex-date are treated as unknown.
--issuer-notice-repair False corporate_actions only: repair payment dates and reviewed bonus/transfer share terms using issuer implementation announcements only (reviewed list, CNINFO, BSE); unmatched events stay as gaps and Baostock is not queried.
--baostock-repair False corporate_actions only: explicitly repair delisted Shanghai and Shenzhen symbols with Baostock.
--ths-repair False corporate_actions only, for historical migration: fill historical dividends and ex-rights of delisted BSE symbols from THS.
--eastmoney-bj-repair False corporate_actions only, for historical migration: fill historical dividends and ex-rights of old BSE codes via the current 920xxx EastMoney codes.
--eastmoney-date-repair False corporate_actions only: request historical ex-rights rows from EastMoney day by day for the ex-dates given in --ex-dates. The primary source for the backfill path is TDX; only EastMoney's daily-update equality filter can reach rows before 2015-09-29.
--ex-dates — With --eastmoney-date-repair: comma-separated ex-dates, YYYY-MM-DD.
--bse-tip-repair False daily_bars only, for historical migration: fill BJ turnover for existing current-period trading days from the BSE website without refetching Sina. Daily updates already use the BSE quote board as the primary current-period source for BJ.
--bj-amount-repair False daily_bars only, superseded by --tdx-amount-repair: fill BSE turnover that Sina never published from TDX; stored prices and volumes are never touched. Requires --start/--end.
--tdx-amount-repair False daily_bars only: cross-check historical Shanghai, Shenzhen and Beijing rows filled from Sina against TDX, filling turnover only when OHLC match and the volume difference is under one lot; codes TDX lacks keep the Sina rows. Stored prices and volumes are never touched. Requires --start/--end.
--tdx-volume-repair False daily_bars only: re-read TDX and rewrite only the volume of stored TDX rows (fixes the decoding bug before 2026-09-17); prices must match, and turnover values under 64.5 yuan, which the same bug inflated, are rewritten too; adds no rows. Requires --symbols and --start/--end.
--turnover-repair False daily_bars only: replace Shanghai/Shenzhen stock rows whose turnover is missing, zero or has misaligned volume/amount units with the whole same-day Baostock row; OHLC must agree within half a cent, otherwise or if unavailable the original values are kept. Requires --start/--end.
--turnover-peer-review False With --turnover-repair: review price conflicts using historical exchange prices, TDX and EastMoney; replace whole bars only with agreeing evidence, never splice exchange-wide turnover.
--fill-em-outage False valuation_metrics only: when the EastMoney snapshot is interrupted, fill the --start/--end window after EastMoney's last complete day and before today from the EastMoney datacenter valuation report; writes only when the whole market is retrieved.

cne check

Option Default Description
--config configs/cnequity.toml Path to the config file.
--full False Rerun the full-lake audit now (reads every historical partition; can take hours on a large lake); by default reads the latest audit result.
--pack — Report window, gaps and next steps per research pack. Repeatable. When given, missing data or uncovered historical ST worsens the exit code.

cne config

Option Default Description
action — Required; positional argument
--config configs/cnequity.toml Path to the config file.
--force False With action=create: overwrite an existing config file.
--data-root — With action=create: set [data].root (defaults to ./data/cnequity resolved to an absolute path).
--dry-run False With action=upgrade: only list the steps and schedule groups to add; writes no files.

cne contract diff

Option Default Description
old_contract — positional argument
new_contract — positional argument
--old — Path to the baseline contract file.
--new — Path to the candidate contract file.
--from — Alias for --old.
--to — Alias for --new.
--json False Output machine-readable JSON.
--allow-breaking False Exit with code 0 even when breaking changes are found.

cne contract show

Option Default Description
dataset — positional argument
--dataset — Dataset name (can also be passed as an argument). Omit to print the full contract.
--out, --output, --path - Write the JSON to this path instead of stdout; '-' means print.
--json False Output machine-readable JSON (default).

cne contract validate

Option Default Description
contract_path — positional argument
--path — Path to the contract JSON (can also be passed as an argument).
--json False Output machine-readable JSON.
--against-registry False Require the contract in the file to match the current DATASETS / SCHEMAS / PRIMARY_KEYS exactly.

cne decision-data cash-rights

Option Default Description
--start 2016-01-01 —
--end — Defaults to today; when [research] holdout_start is configured, defaults to the day before it.
--output-dir — —
--config configs/cnequity.toml Path to the config file.

cne decision-data payment-gaps

Option Default Description
--start 2016-01-01 —
--end — Defaults to today; when [research] holdout_start is configured, defaults to the day before it.
--output-dir — —
--config configs/cnequity.toml Path to the config file.

cne decision-data stock-terms

Option Default Description
--start 2016-01-01 —
--end — Defaults to today; when [research] holdout_start is configured, defaults to the day before it.
--output-dir — —
--config configs/cnequity.toml Path to the config file.

cne delisted status

Option Default Description
--config configs/cnequity.toml Path to the config file.
--since 2016-01-01 Start of the lake window.
--sample 15 Number of detail rows to print.

cne derive

Option Default Description
name adj_factors positional argument
--config configs/cnequity.toml Path to the config file.
--full False Rewrite all partitions of adj_factors / industry_index / option_greeks / minute_bars_15m|30m|60m (default: incremental only).
--start — industry_index / trading_status / option_greeks / minute_bars_15m|30m|60m: derive only this date (YYYY-MM-DD) and later.
--end — industry_index / trading_status / option_greeks / minute_bars_15m|30m|60m: derive only this date (YYYY-MM-DD) and earlier.
--apply False bse_code_migration: actually rewrite partitions; adj_factor_source: write per-security source overrides and recompute factors for those securities (default: report only).

cne doctor

Option Default Description
--config configs/cnequity.toml Path to the config file.
--json False Output machine-readable JSON.

cne init

Option Default Description
--config configs/cnequity.toml Path to the config file.
--profile quick How big to build. demo = fetch a few symbols from real sources; sample = the same shape but offline and deterministic — neither is a market. quick = all symbols, last 3 years; full = all symbols since 2016-01-01 (usually needs more pages). You can deepen history later with cne backfill daily_bars.
--symbols 600519.SH,000001.SZ,000858.SZ,300750.SZ,601318.SH demo/sample: symbols to fetch, comma-separated (deliberately few).
--days 30 demo/sample: roughly how many recent trading days of daily_bars to fetch.
--data-root data/cnequity-demo demo/sample: separate lake root (do not use it for a full-market init).
--config-out configs/cnequity.demo.toml demo/sample: where to write the small config for later cne query use.
--force False demo/sample: allow overwriting an existing --config-out with different content; by default refuses and keeps the original file.
--intraday False demo/sample: also fetch 1-minute bars for the same symbols (up to 5 trading days) and print one trading day, so the bar_time convention is visible.
--research False demo/sample: also derive hfq adjustment factors from Sina and print an unadjusted vs. adjusted return comparison (slower; needs access to Sina).
--layout-only False Create only directories, the manifest and DuckDB views; skip the init stages.
--trade-date — As-of trading day (YYYY-MM-DD) for the init stages; defaults to today.
--resume False Resume the most recent unfinished init run (retry failed batches + fill missing stages).
--run-id — Resume the given init run_id (implies --resume).
--keep-going False Keep going after a stage fails instead of stopping.
--since — Explicit history start (YYYY-MM-DD); overrides --profile.
--quiet False Show only warnings and above; no per-batch progress.
--pack — Research pack: market (market data), fundamentals, universe (historical ST). Does not change what this init downloads. Decides which schedule groups stay updated afterward and the verdict of cne check --pack. Repeatable. If omitted, the saved selection is reused; the first time it is market.
--schedule False After init succeeds, install the scheduled daily update and closing catch-up for the selected research packs. Excludes announcements and news.
--json False Print the full machine-readable result at the end instead of the summary; the full result is always saved to the log directory too.
--no-preflight False Skip the network preflight (TDX, exchanges, EastMoney) of up to 8 seconds before the run starts. Setting CNE_SKIP_PREFLIGHT=1 does the same.

cne mcp

Option Default Description
--config configs/cnequity.toml Path to the config file.
--live False Fetch data missing from the lake on demand from the source, without writing it to disk. Supports only symbol lookup and unadjusted daily bars; other tools refuse rather than answer without price adjustment, universe and PIT.
--http False Use Streamable HTTP instead, listening on /mcp. For clients that only accept a remote URL (such as ChatGPT), used with a tunnel.
--host 127.0.0.1 Listen address for --http. A non-loopback address requires --token.
--port 8788 Port for --http.
--token — --http: every request must carry this token (Bearer header, /mcp/ path or ?token=). Required when exposed publicly through a tunnel.

cne profile list

Option Default Description
--include-compatibility, --official-only True Include legacy universe aliases in the list.

cne profile show

Option Default Description
name — Required; positional argument
--symbol — Bind the profile to concrete symbols and include concrete_scope_hash.

cne query

Option Default Description
--config configs/cnequity.toml Path to the config file.
--sql SELECT COUNT(*) AS n FROM daily_bars —
--dataset — Dataset name to fetch on demand
--symbol — Symbol to fetch on demand
--refresh False Refresh the on-demand cache before fetching (requires both --dataset and --symbol).

cne repair adj-factors

Option Default Description
--config configs/cnequity.toml Path to the config file.
--apply False Publish supported factor corrections and retain old revisions; unresolved events remain advisory.
--refresh-sources False Fetch independent factor evidence; uses local caches only by default.
--symbols — Comma-separated symbols; checks historical issues in bounded batches by default.
--start — Start of the event window (YYYY-MM-DD); cumulative effects continue afterward.
--end — End of the event window (YYYY-MM-DD); cumulative effects continue afterward.
--max-symbols 100 Maximum symbols per batch; saves historical progress after applying.
--plan — Require the specified preview plan ID; changed inputs require a new preview.

cne repair corporate-action-gaps

Option Default Description
--config configs/cnequity.toml Path to the config file.
--apply False Fetch from Baostock and publish a new version; by default only prints the plan offline.

cne repair daily-bar-coverage

Option Default Description
--config configs/cnequity.toml Path to the config file.
--apply False Retire BSE session debts and proven pre-listing debts using committed data; preview by default.

cne repair financial-announcements

Option Default Description
--config configs/cnequity.toml Path to the config file.
--apply False Append explicitly marked original-disclosure reconstructions; preview only by default.

cne repair financial-originals

Option Default Description
--config configs/cnequity.toml Path to the config file.
--symbols — Comma-separated stock symbols.
--all-stocks False Use the lake stock catalogue; choose this or --symbols.
--after — Resume from the previous next_cursor (YEAR:SYMBOL); retry failures without a cursor.
--quarter Q4 Report period: Q2 is half-year and Q4 annual; income and cash flow use year-to-date figures only.
--start-year 2016 —
--end-year 2024 —
--max-reports 16 —
--reparse False Reparse existing original reports; unchanged facts retain their original observation times.
--refresh-sources False Fetch complete CNINFO announcement queries and original periodic reports; replay archived sources by default.
--apply False Append verifiable current-year figures from original reports; retain existing vintages and honest observation times.

cne repair fund-factors

Option Default Description
--config configs/cnequity.toml Path to the config file.
--apply False Publish corrected factors from recorded split and transfer terms, retaining the old revision; preview by default.

cne repair fund-listing-dates

Option Default Description
--config configs/cnequity.toml Path to the config file.
--apply False Archive exchange directories and publish missing fund listing dates; preview by default.

cne repair fund-no-print

Option Default Description
--config configs/cnequity.toml Path to the config file.
--apply False Approve fund auction-bar coverage evidence and retire corresponding debts without creating bars or halt rows.
--refresh-sources False Fetch historical SSE/SZSE fund reports; replays retained reports offline by default.
--max-sessions 32 Maximum owed trading sessions to review per batch.

cne repair fund-volume

Option Default Description
--config configs/cnequity.toml Path to the config file.
--apply False Replace verified whole rows and publish a retained revision.
--refresh-sources False Archive official historical K-lines and any required independent turnover evidence; replay archives offline by default.
--max-symbols 16 —

cne repair index-history

Option Default Description
--config configs/cnequity.toml Path to the config file.
--index-symbol 399001.SZ Select a reviewed historical membership catalog.
--apply False Replace whole membership history within the reviewed range; retain official dated weights and old revisions.
--refresh-sources False Archive missing official historical attachments from the catalog; replay offline by default.

cne repair index-snapshots

Option Default Description
--config configs/cnequity.toml Path to the config file.
--indices — Comma-separated indices; defaults to CSI 300, STAR 50, Shenzhen Component and ChiNext.
--apply False Replace complete index snapshots using their actual file dates; retain old revisions.
--refresh-sources False Fetch official constituent and weight files; replay offline by default.

cne repair layout

Option Default Description
dataset — Required; positional argument
--config configs/cnequity.toml Path to the config file.
--apply False Write and publish a new version; by default only prints the plan.

cne repair misdated-valuation

Option Default Description
--config configs/cnequity.toml Path to the config file.
--apply False Fetch from the EastMoney datacenter and publish a new version; by default only prints the plan offline.

cne repair missing-values

Option Default Description
dataset — Required; positional argument
--config configs/cnequity.toml Path to the config file.
--apply False Replace missing-value zero placeholders with nulls and publish a retained revision; preview only by default.

cne repair orphan-symbols

Option Default Description
--config configs/cnequity.toml Path to the config file.
--apply False Publish a new version after verification; by default only prints the plan.

cne repair stale-suspensions

Option Default Description
--config configs/cnequity.toml Path to the config file.
--apply False Publish a new version after verification; by default only prints the plan.

cne repair status-listing-window

Option Default Description
--config configs/cnequity.toml Path to the config file.
--apply False Publish a new version after verification; by default only prints the plan.

cne repair status-outages

Option Default Description
--config configs/cnequity.toml Path to the config file.
--start — Required; Window start (YYYY-MM-DD).
--end — Required; Window end (YYYY-MM-DD).
--apply False Publish a new version after verification; by default only prints the plan.

cne repair status-traded

Option Default Description
--config configs/cnequity.toml Path to the config file.
--start — Required; Start of the traded-status repair window (YYYY-MM-DD).
--end — Required; End of the traded-status repair window (YYYY-MM-DD).
--apply False Publish a new version after verification; by default only prints the plan.

cne repair stock-listing-dates

Option Default Description
--config configs/cnequity.toml Path to the config file.
--apply False Publish stock listing dates confirmed by the official IPO calendar; retain old revisions.
--refresh-sources False Fetch CNINFO IPO calendars; replay archived sources by default.
--max-sessions 32 —
--event-date — Replay official listing events for an additional date; repeatable and usable before a stock has daily bars.

cne repair valuation-basis

Option Default Description
--config configs/cnequity.toml Path to the config file.
--apply False Write and publish a new version; by default only prints the plan.

cne run clean

Option Default Description
--config configs/cnequity.toml Path to the config file.
--dry-run False Compatibility option; all cleanup is now preview-only.
--orphan-retention-days 7 Preview orphan staging older than this many days that is not recorded in the manifest.
--snapshot-retention-days 14 Preview meta/source_snapshots run_id directories older than this many days (the latest one per dataset / source is always kept).
--force False Also include unfinished or uncompacted staging in the preview; deletes no files and does not downgrade batches.
--keep-revision-generations 5 Keep the latest this many generations plus current/hold per dataset; other versions are only listed as candidates, not marked, and no bytes are freed. Import a reference manifest before marking in the web UI. 0 skips version handling.
--log-retention-days 30 Preview logs/cne-*.log older than this many days, without deleting; 0 skips.
--reconcile-runs False Before cleanup, mark runs stuck in 'running' (crashed worker) as failed.
--reconcile-after-seconds — Apply the reconciliation above only to runs silent for more than this many seconds (defaults to [orchestrator].batch_stale_seconds).

cne run compact

Option Default Description
--config configs/cnequity.toml Path to the config file.
--run-id — Publish only this run; by default handles all runs pending publication.

cne run daily

Option Default Description
--config configs/cnequity.toml Path to the config file.
--groups — Restrict --stale-only to these daily schedule groups (comma- or space-separated).
--group — Schedule groups: core, capital, signals, fundamentals, macro_risk, research, intraday, ticks
--all-groups False Run all schedule groups only, without the event streams. Kept for old schedules that run cne run events separately; cne run daily without arguments already includes all schedule groups and event streams.
--core-only False Run only the [[job.daily.waves]] core skeleton (the old no-argument behavior).
--no-events False When run without arguments, skip the event streams (announcements, regulatory events, news).
--trade-date — As-of trading day YYYY-MM-DD (default today). Use for catch-up runs on weekends / holidays.
--backfill False Run with backfill semantics: skip the trading-day gate and each step's own incremental window, and fetch the window given by the backfill scope in the config instead. Used to rerun a day the schedule missed; scheduled runs never pass it.
--repair-gaps False Before the daily / stale run, repair verified historical gaps that have an honest source.
--quiet False Show only warnings and above; no per-step progress.
--stale-only False Refetch only datasets still behind the last trading day. Run it a few hours after the main pipeline: once a snapshot dataset loses the day's window to a source outage, it cannot be recovered the next day.
--snapshots-only False With --stale-only: refetch only snapshot datasets; historical datasets are filled by date in the next daily update.
--pack — Run only the daily schedule groups for these research packs, without the event streams. If omitted, all schedule groups and event streams still run. Repeatable.

cne run events

Option Default Description
--config configs/cnequity.toml Path to the config file.
--group — One group from [job.events.groups] (default: run all in order).
--trade-date — As-of calendar date YYYY-MM-DD (default today), including weekends and holidays.
--quiet False Show only warnings and above; no per-step progress.

cne run retry

Option Default Description
--config configs/cnequity.toml Path to the config file.
--run-id — Retry the given run.
--failed-groups False Retry the most recent failed run of each daily schedule group.

cne serve

Option Default Description
--config configs/cnequity.toml Path to the config file.
--host 127.0.0.1 A loopback address listens on both 127.0.0.1 and localhost. A non-loopback address requires --token.
--port 8787 —
--token — Require this bearer token (or ?token=). Required when --host is not a loopback address.
--read-only False Browse only. Do not register the write endpoints of the operations page and storage cleanup.
--allow-remote-ops False Allow starting fetches from the dashboard on non-loopback addresses too. By default remote clients can only browse and run storage cleanup; the token is in the URL and the LAN is plaintext.

cne snapshot create

Option Default Description
name — Required; positional argument
--research False Include prices, factors, identity, status, calendar and research coverage evidence; errors if dependencies are missing.
--dataset — Required; Dataset to include (repeatable). Snapshots are always explicit, never the whole lake.
--config configs/cnequity.toml Path to the config file.
--snapshot-root — Where to put the snapshot; defaults to meta/snapshots under the data root.

cne snapshot delta apply

Option Default Description
name — Required; positional argument
target — Required; positional argument
--dry-run False Only validate preconditions; do not modify TARGET.
--config configs/cnequity.toml Path to the config file.
--snapshot-root — Where to put the delta package; defaults to meta/snapshots under the data root.

cne snapshot delta create

Option Default Description
name — Required; positional argument
--from — Baseline lake root. The target root is compared against it byte for byte.
--to — Target lake root; defaults to the currently active root in the config.
--from-revision — Use the revision committed in the target as the baseline precondition.
--dataset — Dataset to include (repeatable). If omitted, auto-discover datasets present in both roots.
--config configs/cnequity.toml Path to the config file.
--snapshot-root — Where to put the delta package; defaults to meta/snapshots under the data root.

cne snapshot delta verify

Option Default Description
name — Required; positional argument
--config configs/cnequity.toml Path to the config file.
--snapshot-root — Where to put the delta package; defaults to meta/snapshots under the data root.

cne snapshot export

Option Default Description
name — Required; positional argument
destination — positional argument
--compression auto Archive encoding; auto prefers tar.zst and falls back to tar.gz.
--config configs/cnequity.toml Path to the config file.
--snapshot-root — Where to put the snapshot; defaults to meta/snapshots under the data root.

cne snapshot import

Option Default Description
archive — Required; positional argument
--name — Name of the imported snapshot; defaults to the archive file name.
--overwrite False Replace an existing snapshot with the same name only after the archive passes verification.
--config configs/cnequity.toml Path to the config file.
--snapshot-root — Where to put the snapshot; defaults to meta/snapshots under the data root.

cne snapshot restore

Option Default Description
name — Required; positional argument
target — Required; positional argument
--config configs/cnequity.toml Path to the config file.
--snapshot-root — Where to put the snapshot; defaults to meta/snapshots under the data root.

cne snapshot verify

Option Default Description
name — Required; positional argument
--config configs/cnequity.toml Path to the config file.
--snapshot-root — Where to put the snapshot; defaults to meta/snapshots under the data root.

cne sources limits

Option Default Description
--config configs/cnequity.toml Path to the config file.

cne sources policy

Option Default Description
source — positional argument
--profile — —
--redistribution False —

cne sources probe

Option Default Description
--config configs/cnequity.toml Path to the config file.
--vantage local Where this probe runs from — 'cn', 'overseas', or any label you use. Some sources reject non-mainland egress, so results without this label cannot be interpreted.
--only — Keys to probe, comma-separated; costly/challenged endpoints are probed only when listed explicitly.
--stale-only False Reuse collection evidence verified within 12 hours; actively probe only endpoints lacking fresh evidence.
--list False List probe source names offline; no config needed.
--out — Where to write the JSON report. Defaults to meta/source_health/.json in the lake, which cne serve also reads.

cne sources resilience

Option Default Description
--config configs/cnequity.toml Path to the config file.
--out — —
--enforce False Exit 1 when a core dataset has no independent backup.
--with-availability False Attach measured probe availability to each failure domain (reads the lake).
--window-days 30 —

cne sources slo

Option Default Description
--config configs/cnequity.toml Path to the config file.
--window-days 30 —
--minimum-observations 10 —
--enforce False Exit 1 when a critical source misses its SLO.

cne sources substitutes

Option Default Description
--config configs/cnequity.toml Path to the config file.
--vantage local Which egress location (vantage) report to read.
--probe, --no-probe False Measure now instead of reading the stored report. Makes the same requests as sources probe.
--json False Output machine-readable JSON.

cne stats rebuild

Option Default Description
--config configs/cnequity.toml Path to the config file.
--dataset — Recompute only these datasets (repeatable). Rows for other datasets stay unchanged.
--if-stale False Do nothing unless collection has run since the stats were built. Safe to put on a timer.
--json False Print the result as JSON.

cne stats show

Option Default Description
--config configs/cnequity.toml Path to the config file.
--dataset — Per-partition detail for one dataset.
--by-source False Group by source / data_version instead.
--json False Output machine-readable JSON.

cne status

Option Default Description
--config configs/cnequity.toml Path to the config file.
--run — Run id to show, or 'latest' (default). Includes stage results per dataset.
--datasets False Per-dataset freshness: coverage range, watermark, and whether it is stale relative to the last trading day.
--all-columns False With --datasets: print all columns of the dataset inventory, not just freshness.
--hide-empty False With --datasets: list only datasets that hold data or are stale, and fold the empty ones into one line.
--groups — With --datasets: fail only on datasets owned by these schedule groups (space- or comma-separated). Datasets of other groups are still listed and reported as schedule gaps but do not fail the gate. The cross-section check follows it too: daily_bars coverage is judged by whichever group owns it. An unfinished init belongs to no schedule group and always fails.
--scope, --no-scope True With --datasets: whether to run the cross-sectional symbol check for the latest trading day. It reads the daily_bars tip partition, instruments and trading_status, which costs more than checking watermarks alone; --no-scope returns this command to pure metadata.
--gate False Enforce the gate for the selected scope and freshness; by default only reports.

cne storage apply

Option Default Description
--config configs/cnequity.toml Path to the config file.
plan_id — Required; positional argument
--phase mark mark marks in place; purge is disabled, use the serve storage operations page instead.
--maintenance-window False Compatibility option; cannot bypass the web delete confirmation.

cne storage archive

Option Default Description
--config configs/cnequity.toml Path to the config file.
object_id — Required; positional argument
--destination — Required

cne storage artifact-verify

Option Default Description
--config configs/cnequity.toml Path to the config file.
object_id — Required; positional argument

cne storage experiment-apply

Option Default Description
--config configs/cnequity.toml Path to the config file.
plan_id — Required; positional argument
--maintenance-window False Compatibility option; cannot bypass the web delete confirmation.

cne storage experiment-create

Option Default Description
--config configs/cnequity.toml Path to the config file.
--parent — Required
--case-id — Required

cne storage experiment-plan

Option Default Description
--config configs/cnequity.toml Path to the config file.
--phase mark —

cne storage experiment-seal

Option Default Description
--config configs/cnequity.toml Path to the config file.
object_id — Required; positional argument
--artifact-id — Required

cne storage explain

Option Default Description
--config configs/cnequity.toml Path to the config file.
object_id — Required; positional argument

cne storage hold

Option Default Description
--config configs/cnequity.toml Path to the config file.
object_id — Required; positional argument
--reason — Required

cne storage import

Option Default Description
--config configs/cnequity.toml Path to the config file.
--manifest — Required

cne storage inspect

Option Default Description
--config configs/cnequity.toml Path to the config file.
--keep 5 —

cne storage plan

Option Default Description
--config configs/cnequity.toml Path to the config file.
--keep 5 —
--phase mark —

cne storage resolve

Option Default Description
--config configs/cnequity.toml Path to the config file.
old_path — Required; positional argument
--artifact-id — Explicitly select one artifact when several sealed versions exist.

cne ths-official backfill

Option Default Description
--config configs/cnequity.toml Path to the config file.
--start 2016-01-01 Start report period.
--end 2024-12-31 End report period.
--chunk-size 200 Securities per staging batch.
--workers 4 Number of concurrent requests.
--symbols — Comma-separated symbols instead of the whole market, to retry failed securities; the final JSON lists securities still missing in failed_symbols.

cne ths-official capture

Option Default Description
--config configs/cnequity.toml Path to the config file.
--what all Which peer snapshot to fetch.
--days 45 Bar window in calendar days.
--sample 400 Number of securities to sample for bars.

cne ths-official repair-bars

Option Default Description
--config configs/cnequity.toml Path to the config file.
--start 2005-01-01 —
--end 2015-12-31 —
--apply False Actually write. Without it, only report differences and change nothing.
--adjudicator — Parquet of (symbol, trade_date, close) from an independent source.
--diff-out — Write disputed rows here.
--workers 4 —

cne ths-official resource-sectors

Option Default Description
--config configs/cnequity.toml Path to the config file.
--start 2022-01-04 Service start date.
--end — Defaults to today.
--apply False Actually write. Without it, only fetch and report, changing nothing.
--workers 4 —

cne verify

Option Default Description
--config configs/cnequity.toml Path to the config file.
--derivatives False Read-only acceptance check of a derivatives research window; requires --dataset, --start, --end.
--bars False Check "security × trading day" instead, including securities with no rows at all in the window. Requires --start.
--runs False Check run evidence over consecutive trading days instead; fills no gaps.
--dataset — Validate only these datasets (comma-separated); by default validates everything in the registry.
--repair False Run backfill over fillable gaps, dataset by dataset from newest to oldest.
--kind — Show only these gap types: empty,stale,interior,shallow.
--start — With --bars/--derivatives: coverage window start (inclusive).
--end — Coverage window end; --bars defaults to the last complete trading day, required for --derivatives.
--days — With --runs: number of consecutive trading days required (default 20).
--as-of — With --runs: cutoff date YYYY-MM-DD (inclusive).
--enforce False With --runs: exit 1 if the consecutive-days gate fails.