CLI reference

The DeepCell CLI, in full

Five surfaces, every guide topic, every command and every rule — generated from the CLI itself, so what is on this page is what your terminal answers.

Handing this to an agent instead of reading it? The same reference, in plain markdown: /product/cli.md

Start here

Install the CLI. No account is needed to begin — the first call mints an anonymous session, and everything on this page works from a cold install.

macOS / Linux

curl -LsSf https://deepcell.net/install.sh | sh

Windows (PowerShell)

irm https://deepcell.net/install.ps1 | iex

Then check the install in one call: version, whether the service is reachable, who you are, and which project is active.

deepcell doctor

Read the guided walkthrough, then list what is in your project. If the second one prints, you are connected.

deepcell guide orient/start
deepcell ls

Signing in is optional and belongs after your first file, not before it. It keeps your work beyond the anonymous session, lifts the anonymous limits, and lets you share what you build.

deepcell login

The five surfaces

The reference is split by the question you are asking at that instant, because each kind of material has a different shape, a different read frequency, and a different risk of going stale. Reach for the one that matches your question rather than reading the set.

Surface	The question you are asking	What it answers
deepcell help	How do I invoke this exactly?	Every command, flag, exit code and example as one document.
deepcell rules	What must always hold?	The invariants applicable to a .deepcell work shape.
deepcell guide	What is the procedure for this stage?	Explain how DeepCell itself works.
deepcell ref	What values are legal here?	Look up legal values, and resolve any typed id.
deepcell example get	What does a correct one look like?	Write an example document to a local file.

Two of them — the invocation reference and the legal-values reference — are derived from the implementation, so they cannot drift from it. The other three are written by hand and tied back mechanically: every id they cite has to resolve, and CI fails when one does not.

This page is not a sixth surface. It is a rendering of those five, built from the same manifest the CLI serves, so the two cannot describe different commands. Manifest version: 0.6.3

Every guide topic

Topics are ordered procedure, grouped by the stage of the work they belong to. Read the one for the stage you are in rather than the whole index. Print any of them from a terminal:

deepcell guide orient/start

Topic	Stage	What it covers
orient/start	orient	Inspect the environment and existing work before choosing a route
orient/how-to-work	orient	Shared working contract for connected, challengeable DeepCell work
orient/surface-ownership	orient	Know which surface owns each fact, judgment, explanation, and takeaway
orient/concepts	orient	Understand the six core concepts used by the Spreadsheet surface
orient/choose-shape	orient	Choose the decision, evidence, and work surfaces the question needs
ingest/tabular	ingest	Bring external tables in faithfully without inventing projections
generate/first-file	generate	Create one valid file for the selected surfaces and build on it
generate/structure	generate	Define Spreadsheet items, contexts, statuses, and dimensions
generate/calcs	generate	Encode derived Spreadsheet values as dependency-tracked calculations
generate/values	generate	Author input values and provenance at their exact coordinates
generate/whole-doc	generate	Use one whole-document write when the complete initial shape is known
revise/premise-change	revise	Change a premise, recompute calculations, and reassess every connected surface
revise/values	revise	Change existing values with the narrowest typed operation
revise/structure	revise	Change definitions while preserving references and dependent work
revise/scenarios	revise	Compare what-if overlays without copying the underlying work
revise/reasoning	revise	Record claims and premises incrementally and preserve their lifecycle
revise/history	revise	Review and preserve the versioned history of the work
verify/lint	verify	Run structural and reasoning lint as the first verification move
verify/query-back	verify	Read calculated outputs back and catch an empty or misaddressed grid
verify/review	verify	Audit every selected surface before calling the work complete
present/layout	present	Lay out Spreadsheet results for inspection and delivery
present/prose	present	Author long-form explanation with resolvable same-file references
present/charts	present	Turn selected Spreadsheet ranges into charts without copying values
present/decks	present	Build a concise Deck whose takeaways remain linked to their basis
present/deck-style	present	Pick one of four deck style packs and apply its CSS before writing slides
present/deliver	present	Share or export finished work within the active transport limits
overview	reference	Template — three-statement model architecture: sheet layout, item order ranges, and the IS/BS/CF golden loop
assumptions	reference	Template — assumptions sheet: driver categories, order ranges, and why drivers are Values while anything derived is a CalcDef
income-statement	reference	Template — income statement items and formulas, revenue through net income
balance-sheet	reference	Template — balance sheet items and formulas, plus the assets = liabilities + equity check
cash-flow	reference	Template — cash flow statement: operating/investing/financing sections and the cash reconciliation
dcf	reference	Template — DCF valuation: free cash flow build, WACC, terminal value, and the equity bridge
scenarios	reference	Template — worked bull/base/bear setup: which variables to override and by how much (for the mechanics, read revise/scenarios)
validation	reference	Template — integrity check items every model should carry (balance check, cash reconciliation, coverage ratios)
orchestrator	reference	How to run DeepCell work — what the job is, when it is done, and how to look things up instead of guessing
bank	reference	Template — bank / NIM model: rate × balance grid, net interest income, efficiency ratio, provision
insurance	reference	Template — insurance model: earned premium, loss/expense ratios, combined ratio, underwriting result
reit	reference	Template — REIT model: NOI, FFO, AFFO, real-estate depreciation add-back
build-from-scratch	reference	Build playbook — starting with no existing .deepcell file, from empty project to a valid model
account-categorization	reference	Mapping a company's own statement labels onto a standard chart of accounts, without editing the extraction
chart-of-accounts-gaap	reference	Template — US GAAP standard chart of accounts (order 4000-4299), item ids matching the statement templates
chart-of-accounts-ifrs	reference	Template — IFRS standard chart of accounts, and where it diverges from US GAAP
chart-of-accounts-cas	reference	Template — Chinese Accounting Standards (企业会计准则) chart of accounts for A-share filers
non-gaap-metrics	reference	Template — non-GAAP adjusted metrics (order 4300-4399): adjusted EBITDA, net income, and EPS
schema-matching	reference	Mapping external data (xlsx/csv) to .deepcell item and context dimensions
house-rules	reference	House rules — the non-negotiable invariants every model must satisfy
review-dimensions	reference	Review dimensions — the model audit checklist (integrity, formulas, coverage, sanity, grounding, reasoning, intent, presentation)
model-scopes	reference	Choosing model scope — P&L+DCF default, 3-statement triggers, industry models
sec-extraction	reference	SEC extraction — raw historical layer, model mapping layer, provenance rules
cn-extraction	reference	A-share (cninfo) extraction — CAS statements from report PDFs, #page deep links, canonical item map
excel-import	reference	Excel import — dimension mapping, formula conversion, excel_import provenance

Every command

Every command, with the shape of its invocation, the arguments and flags it takes and what each of them has to be, what each exit code means, and one runnable example. The whole catalog is also one call away as machine-readable data — worth caching once instead of paying for a round trip per command:

deepcell help

orient

look at what exists before adding to it

cat

Print file content (XML) to stdout.

deepcell cat <filename>

deepcell cat model.deepcell

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--revision <revision>	text	—	Show file at specific revision.
--workspace <workspace_slug>	text	—	Override active workspace.

Exit codes: 0 — completed

cell-meta

Show metadata for a single cell (formula, dependencies, data source).

deepcell cell-meta <filename> [item_ref_pos] [context_ref_pos]

deepcell cell-meta model.deepcell Revenue FY2026E

Argument	Type	Required
filename	text	required
item_ref_pos	text	optional
context_ref_pos	text	optional

Flag	Type	Default	What it does
--item <item_opt>	text	—	Item ref (alternative to the ITEM_REF positional).
--context <context_opt>	text	—	Context ref (alternative to the CONTEXT_REF positional).
--status <status_ref>	text	—	Status reference (e.g. 'actual'). A CONSTRAINT, not a hint: the read may answer from that bucket or the untagged one, never from a third. Omit to let the document decide which status answers.
--scenario <scenario_ref>	text	—	Scenario dimension (omit for the base cell).
--custom-dimensions <custom_dimensions>	text	—	Custom dimensions as 'dim:member;dim:member', e.g. 'geography:na'.

Exit codes: 0 — completed

describe

Show a document's shape: sheets, the five dimensions, documents, decks.

deepcell describe <filename>

deepcell describe model.deepcell --lint

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--include-reasoning	boolean	—	Append a compact summary of the document reasoning graph.
--scenario <scenario_id>	text	—	Scenario ID whose value overrides to apply.
--lint	boolean	—	Include canonical structural findings; exit 1 on error-level ones. Warn-level findings print and exit 0 — read them.
--since <since_revision>	text	—	With --lint: mark each finding pre-existing or new against this revision. Use `HEAD~1` for the commit before yours, or a SHA from `deepcell log`.
--measure	boolean	—	With --lint: measure every deck slide that has no fit measurement yet (one browser pass per slide in the export service) before reporting. Slides are measured on the write that changes them; use this for a deck that arrived by sync or upload, or was restyled.
--workspace <workspace_slug>	text	—	Override active workspace.

Exit codes: 0 — completed · 1 — read-only-check

grep

Search for items/values matching a pattern in .deepcell files.

deepcell grep <pattern>

deepcell grep Revenue

Argument	Type	Required
pattern	text	required

Flag	Type	Default	What it does
--file <filename>	text	—	Search within a specific file.
--ignore-case	boolean	—	Case-insensitive search.

Exit codes: 0 — completed

ls

List files in the active workspace.

deepcell ls

Exit codes: 0 — completed

query

Query a .deepcell file.

deepcell query <filename> [item_ref] [context_ref] [status_ref]

deepcell query model.deepcell Revenue FY2026E

Argument	Type	Required
filename	text	required
item_ref	text	optional
context_ref	text	optional
status_ref	text	optional

Flag	Type	Default	What it does
--status <status_opt>	text	—	Status dimension — the same thing as the third positional. `edit`, `defs add-calc` and `cell-meta` all spell it this way; accepted here so the four agree.
--scenario <scenario_ref>	text	—	Scenario dimension (omit for default scenario).
--custom-dimensions <custom_dimensions>	text	—	Custom dimensions as 'dim:member;dim:member', e.g. 'geography:na'.
--cells <cells_arg>	text	—	Read several cells that do NOT share a row, in one call: 'ITEM@CONTEXT,ITEM@CONTEXT,...' (add a third '@STATUS' segment per cell to pin its status). This is the check-my-outputs form — a comma-separated CONTEXT_REF only walks one item.
--sheet <sheet_id>	text	—	Render a full sheet as markdown table.
--block <block_id>	text	—	Render a specific block within a sheet.
--workspace <workspace_slug>	text	—	Override active workspace.

Exit codes: 0 — completed

ingest

external data in (skip for from-scratch work)

import

Import an xlsx or csv file into a .deepcell document.

deepcell import <file> --items <items> --contexts <contexts>

deepcell import variance.xlsx --name variance_import --items '[{"id":"Revenue","name":"Revenue","level":0,"row":2,"sheet":"Variance"}]' --contexts '[{"id":"FY25A","name":"FY25 actual","period_type":"annual","status":"actual","column":"B"}]'

Argument	Type	Required
file	path	required

Flag	Type	Default	What it does
--items <items>	text	required	Items JSON string or path to JSON file.
--contexts <contexts>	text	required	Contexts JSON string or path to JSON file.
--name <name>	text	—	Name for the .deepcell file (default: input filename).
--workspace <workspace>	text	—	Target workspace slug.
--aggregations <aggregations>	text	—	Aggregation rules JSON string or path to JSON file.
--keep-raw	boolean	—	Store raw values alongside aggregated results.

Exit codes: 0 — completed · 1 — partial

ingest cn extract

Extract one statement's table — rows, canonical items, #page deep link.

deepcell ingest cn extract <pdf_url>

deepcell ingest cn extract https://static.cninfo.com.cn/finalpage/2026-03-28/1224567890.PDF --statement income --persist

Argument	Type	Required
pdf_url	text	required

Flag	Type	Default	What it does
--statement <statement>	text	合并利润表	Chinese heading or income \| balance \| cash_flow
--persist	boolean	—	Mirror the source PDF into DeepCell storage and return a durable `source_page_url` to record as the <Source> <Locator>. --no-persist skips the mirror (faster, but the only url you get back is the volatile cninfo link).

Exit codes: 0 — completed

ingest cn filings

List annual / interim reports with PDF permalinks.

deepcell ingest cn filings <code>

deepcell ingest cn filings 600519 --type annual --count 5

Argument	Type	Required
code	text	required

Flag	Type	Default	What it does
--type <filing_type>	text	annual	annual \| interim \| semiannual \| q1 \| q3
--count <count>	integer range	5	number of reports (1-30)

Exit codes: 0 — completed

ingest cn search

Resolve a 6-digit code, company name (中文简称), or pinyin.

deepcell ingest cn search <keywords>

deepcell ingest cn search 600519

Argument	Type	Required
keywords	text	required

Exit codes: 0 — completed

ingest cn statements

Locate the financial statements inside a report PDF (page + scale).

deepcell ingest cn statements <pdf_url>

Argument	Type	Required
pdf_url	text	required

Exit codes: 0 — completed

generate

create one file, then build only the surfaces the work needs

deck add

Add a Deck to a .deepcell file.

deepcell deck add <filename> --name <name>

deepcell deck add model.deepcell --name <name>

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--deck-id <deck_id>	text	—	Deck id. Omit to let the server assign one.
--name <name>	text	required	Display name for the deck.
--aspect-ratio <aspect_ratio>	16:9 \| 4:3	—	Slide aspect ratio. Omit for the format default (16:9).
--index <index>	integer	—	Position among decks (0-based).
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed

deck add-slide

Add an empty slide to a deck.

deepcell deck add-slide <filename> --deck <deck_id> --name <name>

deepcell deck add-slide model.deepcell --deck <deck_id> --name <name>

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--deck <deck_id>	text	required	Deck to add the slide to.
--slide-id <slide_id>	text	—	Slide id. Omit to let the server assign one.
--name <name>	text	required	Display name for the slide.
--index <index>	integer	—	Position within the deck (0-based).
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed

deck bind

Point a slide at a live value, or update an existing binding.

deepcell deck bind <filename> --deck <deck_id> --binding-id <binding_id> --binding-kind <binding_kind>

deepcell deck bind model.deepcell --deck <deck_id> --binding-id <binding_id> --binding-kind <binding_kind>

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--deck <deck_id>	text	required	Deck the binding lives on.
--binding-id <binding_id>	text	required	Binding id. Reusing one updates it in place.
--binding-kind <binding_kind>	value \| series \| chart \| document_stat \| reasoning \| source \| htmlblock	required	What the binding renders. Decides which address flag it takes.
--field <field>	text	—	Which text of the addressed thing to render, not an address itself.
--ref <ref>	text	—	Single coordinate the binding reads.
--refs <refs>	text	—	Comma-separated coordinates — the address a `series` binding takes. Single-quote an item id that contains a comma.
--metric <metric>	dataSourceCount \| claimCount \| assumptionCount \| evidenceCount	—	For --binding-kind document_stat only: which element type to count.
--number-format <number_format>	text	—	Excel-style number pattern the value renders with — `#,##0.0`, `0.0%`, `#,##0;(#,##0)`. It labels the stored value and never divides it.
--prefix <prefix>	text	—	Text rendered before the value.
--suffix <suffix>	text	—	Text rendered after the value.
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed

deck brand

Recolour a deck by ROLE without touching its stylesheet.

deepcell deck brand <filename> --deck <deck_id>

deepcell deck brand model.deepcell --deck <deck_id>

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--deck <deck_id>	text	required	Deck to recolour.
--set <assignments>	text	—	Colour-role override, repeatable: --set accent=#0A5C3B --set ink=#111111. Roles are the pack's colour names — accent, ink, series-1 … (`deepcell ref deck-style/hooks`).
--clear	boolean	—	Remove the brand; the pack's own palette shows again.
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed

deck delete

Delete a deck and every slide on it.

deepcell deck delete <filename> <deck_id>

deepcell deck delete model.deepcell <deck_id>

Argument	Type	Required
filename	text	required
deck_id	text	required

Flag	Type	Default	What it does
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed

deck delete-slide

Delete one slide, and the HTML on it.

deepcell deck delete-slide <filename> <slide_id> --deck <deck_id>

deepcell deck delete-slide model.deepcell <slide_id> --deck <deck_id>

Argument	Type	Required
filename	text	required
slide_id	text	required

Flag	Type	Default	What it does
--deck <deck_id>	text	required	Deck the slide belongs to.
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed

deck rename

Change a deck's display NAME.

deepcell deck rename <filename> <deck_id> <new_name>

deepcell deck rename model.deepcell <deck_id> <new_name>

Argument	Type	Required
filename	text	required
deck_id	text	required
new_name	text	required

Flag	Type	Default	What it does
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed

deck rename-slide

Change a slide's display NAME.

deepcell deck rename-slide <filename> <slide_id> <new_name> --deck <deck_id>

deepcell deck rename-slide model.deepcell <slide_id> <new_name> --deck <deck_id>

Argument	Type	Required
filename	text	required
slide_id	text	required
new_name	text	required

Flag	Type	Default	What it does
--deck <deck_id>	text	required	Deck the slide belongs to.
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed

deck reorder

Move a deck to TO_INDEX in the deck order (0-based).

deepcell deck reorder <filename> <deck_id> <to_index>

deepcell deck reorder model.deepcell <deck_id> <to_index>

Argument	Type	Required
filename	text	required
deck_id	text	required
to_index	integer	required

Flag	Type	Default	What it does
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed

deck reorder-slide

Move a slide to TO_INDEX within its deck (0-based).

deepcell deck reorder-slide <filename> <slide_id> <to_index> --deck <deck_id>

deepcell deck reorder-slide model.deepcell <slide_id> <to_index> --deck <deck_id>

Argument	Type	Required
filename	text	required
slide_id	text	required
to_index	integer	required

Flag	Type	Default	What it does
--deck <deck_id>	text	required	Deck the slide belongs to.
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed

deck unbind

Remove a binding, leaving whatever the slide's HTML says in its place.

deepcell deck unbind <filename> <binding_id> --deck <deck_id>

deepcell deck unbind model.deepcell <binding_id> --deck <deck_id>

Argument	Type	Required
filename	text	required
binding_id	text	required

Flag	Type	Default	What it does
--deck <deck_id>	text	required	Deck the binding lives on.
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed

defs add-axis-member

Add a row or a column to a Block.

deepcell defs add-axis-member <filename> --sheet <sheet_id> --block <block_id> --axis <axis> --member <member> --ref <ref>

deepcell defs add-axis-member model.deepcell --sheet variance --block revenue_table --axis rows --member item --ref Gross_Profit

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--sheet <sheet_id>	text	required	Sheet containing the block.
--block <block_id>	text	required	blockId to edit.
--axis <axis>	rows \| columns	required	Which axis to edit: 'rows' (the block's @itemOrders) or 'columns' (its @contextRefs).
--member <member>	item \| context	required	What kind of id --ref is. Pair 'item' with rows, 'context' with columns.
--ref <ref>	text	required	The item id or context id to add.
--index <index>	integer range	—	0-based position on the axis (default: append at the end).
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs add-block

Add a presentation Block (table or chart) to a sheet.

deepcell defs add-block <filename> --sheet <sheet_id> --block-type <block_type> --name <name>

deepcell defs add-block model.deepcell --sheet variance --block-type table --name 'Revenue vs budget' --item-orders Revenue,COGS --context-refs FY2025,FY2026

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--sheet <sheet_id>	text	required	Sheet to add the block to.
--block-type <block_type>	text	required	One of: table, chart, sensitivity, key_value, text. The server stores any string, but the renderer skips a block whose type it does not know, so anything else is written and never drawn.
--name <name>	text	required	Display name / section heading.
--item-orders <item_orders>	text	—	Comma-separated rows, in order: item ids, @order values, or order ranges (e.g. 'revenue,cogs,gross_profit' or '4000-4099'). Stored verbatim as @itemOrders; the reader resolves each token — a number or a range matches @order, anything else matches an itemId. Omit and the block renders empty — see the note above.
--context-refs <context_refs>	text	—	Comma-separated context ids forming the block's columns, in order (e.g. 'FY2024,FY2025'). Omit to show every context.
--index <index>	integer	—	Insertion index within the sheet (default: append at the end).
--format-ref <format_ref>	text	—	FormatDefinitions id this block resolves against. Omit and the block takes the document default (the Format named default_format, else the first one defined). See `deepcell ref format`.
--chart-type <chart_type>	bar \| bar_stacked \| bar_horizontal \| line \| area \| pie \| donut \| waterfall \| range_bar \| scatter	—	Chart type (chart blocks only). 'waterfall' bridges deltas between declared totals; 'range_bar' draws a low..high band per category (the football field).
--category-axis <category_axis>	context \| item	—	Which dimension is the category axis (chart blocks only).
--total-item-refs <total_item_refs>	text	—	Whitespace/comma-separated refs naming the plotted categories that rest on the baseline instead of floating on the running sum (--chart-type=waterfall only). Declared, never inferred: omit it and every step is a delta.
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs add-calc

Add a CalculationDefinition (formula).

deepcell defs add-calc <filename> --item <item_id> --formula <formula>

deepcell defs add-calc model.deepcell --item Revenue --calc-id calc_revenue --formula 'Units_Sold[CURRENT] * Unit_Price[CURRENT]' --status projected

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--item <item_id>	text	required	Item the calc resolves into (itemId).
--calc-id <calc_id>	text	—	Stable calcId for the new calc (e.g. 'calc_stress_low'). Errors if the id is already taken. Omit to let the server assign one — but an auto id is what `defs delete-calc` and `reasoning add-claim --calc-ref` must then quote, so choose your own when the calc has to be citable.
--formula <formula>	text	required	Jingwei formula, e.g. "Revenue[PREVIOUS] * 1.1".
--context <context_ref>	text	—	Pin calc to one or more contextRefs. Pass a CSV (e.g. 'FY25,FY26,FY27') to pin a roll-forward chain to several periods in one call — omit the seed period so its literal is kept. Omit entirely to fan out across every period the item lacks a literal value.
--scenario <scenario_ref>	text	—	Limit calc to this scenarioRef.
--status <status_ref>	text	—	Pin calc to a statusRef (e.g. 'projected'). Strongly recommended for forecast formulas so they coexist with the historical actuals in the same item/context slots — without it the projection stores one untagged cell that answers every status, leaving the actuals nowhere to sit. Not enforced: omitting it succeeds, and the cost shows up later as an actual you cannot store.
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs add-context

Add a ContextDefinition — a period, or a non-temporal axis member.

deepcell defs add-context <filename>

deepcell defs add-context model.deepcell --name FY2025 --context FY2025 --kind period --state closed --status actual

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--name <name>	text	—	The context IDENTIFIER (@contextId), e.g. 'Low_Rent' — not a display label. Must satisfy the reference-id grammar. Set the readable name afterwards with `defs update-context --label`.
--status <status_ref>	text	—	statusRef (optional).
--context <context_ref>	text	—	Explicit contextRef (else server-assigned).
--kind <kind>	text	—	Context kind. Omit (or 'period' / temporal alias) for time columns; pass 'program', 'segment', 'fund', 'region', 'entity', 'product', 'other' (or any snake_case label, ≤32 chars) for non-temporal axes. Always written as @kind on the <Context> element.
--state <state>	text	—	Period state: closed \| open \| future. This is what says whether the period is over — the question the A/E suffix on a context id used to answer by accident. Only meaningful for --kind period.
--as-of <as_of>	text	—	ISO YYYY-MM-DD the period's numbers are stated as of. Documentation and lint input only; never consulted when rendering.
--index <index>	integer	—	Position in contexts list (omit to append at end).
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs add-doc

Add a <Document> — the prose that ships with the model.

deepcell defs add-doc <filename>

deepcell defs add-doc model.deepcell --doc-id variance_note --name 'July variance note' --lang en --body-file variance-note.md

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--doc-id <doc_id>	text	—	Document identifier (@docId). Must match [A-Za-z0-9_.-]+ so a deepcell:doc/<id> reference to it parses back.
--name <name>	text	—	Display title.
--lang <lang>	text	—	BCP-47 language tag, e.g. 'en' or 'zh'.
--body-file <body_file>	file	—	File holding the initial body (else empty).
--notation <notation>	markdown \| text	—	What the body IS. A new document is markdown unless you say 'text', which also stops anchors being stamped into it.
--index <index>	integer	—	Position among documents.
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs add-format

Add a <Format formatId="..."> to FormatDefinitions.

deepcell defs add-format <filename> <format_id>

deepcell defs add-format model.deepcell fmt_statement --rule 'default:fontName=Arial'

Argument	Type	Required
filename	text	required
format_id	text	required

Flag	Type	Default	What it does
--rule <rule_strs>	text	—	One rule as semicolon-separated key=value pairs, e.g. 'target=default; font_color=#000000; number_format=#,##0'. Commas inside a value (such as Excel number formats) are preserved. Repeat the flag for multiple rules. Keys: target, font_color, background_color, font_weight, font_style, font_name, font_size, text_align, indent, number_format, border_top/bottom/left/right.
--inherit	boolean	—	--no-inherit opts the Format out of the IB default base (a total custom theme; writes @inherit="false"). Default inherits the base (add-on model). See `deepcell ref format`.
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs add-item

Add an ItemDefinition (no value).

deepcell defs add-item <filename> --name <name>

deepcell defs add-item model.deepcell --name Revenue --label Revenue --data-type monetary --scale 6 --currency USD --order-mode append

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--name <name>	text	required	Item name (itemId basis).
--label <label>	text	—	Display label (e.g. 'Gross Margin %'); defaults to a humanized form of --name. Written as one <Label lang="en">: no typed op adds a second locale, so a bilingual item (en + zh) is seeded in the initial `deepcell write`.
--level <level>	integer	—	Hierarchy level (0-3).
--parent <parent_item_id>	text	—	Parent itemId (omit for root).
--index <index>	integer	—	Position among siblings (omit to append at end).
--order <order>	integer	—	Explicit @order (must be unique; presentation blocks address rows by order ranges). Overrides --index placement.
--order-mode <order_mode>	append	—	'append' assigns max(existing orders) + 10 — no need to know which orders are taken. Mutually exclusive with --order; overrides --index.
--data-type <data_type>	text	—	DataType element (e.g. 'monetary', 'percentage', 'number').
--unit <unit>	text	—	Unit element (e.g. '%', 'hours', 'tonnes').
--scale <scale>	integer	—	Scale element (units multiplier exponent).
--currency <currency>	text	—	Currency element (ISO code, e.g. 'USD').
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs add-period

Add a ContextDefinition (period, or non-temporal axis member).

deepcell defs add-period <filename>

deepcell defs add-period model.deepcell --name FY2026 --context FY2026 --state future --status projected

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--name <name>	text	—	The period IDENTIFIER (@contextId), e.g. FY2027E — not a display label. Must satisfy the reference-id grammar. Set the readable name afterwards with `defs update-context --label`.
--status <status_ref>	text	—	statusRef (e.g. 'projected').
--context <context_ref>	text	—	Explicit contextRef (else server-assigned).
--kind <kind>	text	—	Context kind. Omit (or pass 'period' / a temporal alias like 'time' / 'year' / 'annual' / 'fy') for time columns; pass e.g. 'program', 'segment', 'fund', 'region', 'entity', 'product', 'other' (or any snake_case label, ≤32 chars) for non-temporal axes. Always written as @kind on the <Context> element.
--state <state>	text	—	Period state: closed \| open \| future. This is what says whether the period is over — the question the A/E suffix on a context id used to answer by accident. Only meaningful for --kind period.
--as-of <as_of>	text	—	ISO YYYY-MM-DD the period's numbers are stated as of. Documentation and lint input only; never consulted when rendering.
--index <index>	integer	—	Position in contexts list (omit to append at end).
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs add-rule

Add a <Rule> to an existing <Format>.

deepcell defs add-rule <filename> <format_id> --target <target>

deepcell defs add-rule model.deepcell fmt_statement --target 'level:0:item' --font-weight bold --number-format '#,##0'

Argument	Type	Required
filename	text	required
format_id	text	required

Flag	Type	Default	What it does
--target <target>	text	required	Rule @target selector (see `deepcell ref format`).
--bg-color <background_color>	text	—	Hex color '#RRGGBB' for backgroundColor.
--font-color <font_color>	text	—	Hex color '#RRGGBB' for fontColor.
--font-weight <font_weight>	text	—	e.g. 'bold' / 'normal'.
--font-style <font_style>	text	—	e.g. 'italic' / 'normal'.
--font-name <font_name>	text	—	Font family name.
--font-size <font_size>	float	—	Font size in points.
--text-align <text_align>	text	—	'left' \| 'center' \| 'right'.
--indent <indent>	integer	—	Indent character count.
--number-format <number_format>	text	—	Excel-style pattern, e.g. '#,##0'.
--border-top <border_top>	text	—	e.g. 'thin #000000' (style + optional hex color).
--border-bottom <border_bottom>	text	—	Bottom border, e.g. 'thin #000000' (style + optional hex color).
--border-left <border_left>	text	—	Left border, e.g. 'thin #000000' (style + optional hex color).
--border-right <border_right>	text	—	Right border, e.g. 'thin #000000' (style + optional hex color).
--index <index>	integer	—	Insert position (omit to append).
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs add-scenario

Add a ScenarioDefinition.

deepcell defs add-scenario <filename>

deepcell defs add-scenario model.deepcell --name downside

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--name <name>	text	—	The scenario IDENTIFIER (@scenarioId), e.g. 'Bull' — not a display label. Must satisfy the reference-id grammar. Set the readable name afterwards with `defs update-scenario --label`.
--base <base_scenario_ref>	text	—	(removed) @baseScenarioRef no longer exists — see `deepcell guide revise/scenarios`.
--context <context_ref>	text	—	The scenario IDENTIFIER (@scenarioId) under the op's wire name, contextRef — the same thing as --name, not a period. Legacy spelling; if both are given, --context wins.
--is-default	boolean	—	Mark as the document's default scenario — clears @isDefault from every other scenario.
--index <index>	integer	—	Position (omit to append at end).
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs add-sensitivity

Add a sensitivity block (data table / scenario comparison).

deepcell defs add-sensitivity <filename> --sheet <sheet_id> --name <name> --spec-file <spec_file>

deepcell defs add-sensitivity model.deepcell --sheet summary --name 'IRR sensitivity' --spec-file sensitivity.json

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--sheet <sheet_id>	text	required	Sheet to add the block to.
--name <name>	text	required	Display name of the sensitivity block.
--index <index>	integer	—	Position among sheet blocks (omit to append at end).
--format-ref <format_ref>	text	—	FormatDefinitions id.
--spec-file <spec_file>	filename	required	JSON with {"axes": [...], "outputs": [...]} (use "-" for stdin).
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs add-sheet

Add a presentation Sheet — a tab in the rendered document.

deepcell defs add-sheet <filename> --label <label>

deepcell defs add-sheet model.deepcell --label 'Variance review' --index 1

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--label <label>	text	required	Sheet tab label, e.g. 'Dashboard'.
--index <index>	integer range	—	0-based position among the sheets (default: append at the end).
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs add-source

Declare a <Source> - the one place an outward address may live.

deepcell defs add-source <filename> --id <source_id>

deepcell defs add-source model.deepcell --id <source_id>

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--id <source_id>	text	required	Stable sourceId, e.g. 'src_aapl_10k_fy25'.
--kind <kind>	text	—	What the source physically IS - closed set: filing, webpage, pdf, workbook, dataset, query, transcript, media, message, document, person, derived, other. What it is USED AS goes in --role.
--role <role>	text	—	What the source is being used AS - free text: historical_actual, assumption, analyst_estimate, management_guidance, industry_benchmark, market_data, manual, ...
--reach <reach>	text	—	Can a recipient open it? public \| account \| private \| offline. 'private' withholds the locator on share and export; 'offline' means no locator exists, which is a complete record, not a broken one.
--title <title>	text	—	Human-readable title - what renders when the locator is withheld.
--locator <locator>	text	—	The one outward address (URL, path, DSN).
--description <description>	text	—	Longer note about the source.
--at <at>	text	—	Default position inside the source: text:HEADING[,SUFFIX] \| page:47 \| sheet:Name!A1:B9 \| row:1042 \| col:arr \| t:00:14:32 \| anchor:id.
--effective-date <effective_date>	text	—	ISO date the source describes.
--retrieved-at <retrieved_at>	text	—	ISO timestamp it was fetched.
--issuer <issuer>	text	—	Who published it.
--ticker <issuer_ticker>	text	—	Issuer ticker symbol.
--identity <identities>	text	—	Declared identity as 'scheme:value' (e.g. 'sec.accession:0000320193-25-000079'). Repeatable.
--items <item_refs>	text	—	CSV of itemRefs this source backs.
--contexts <context_refs>	text	—	CSV of contextRefs. Omit to cover every context the statusRef allows.
--status <status_ref>	text	—	statusRef for the coverage row.
--scenario <scenario_ref>	text	—	scenarioRef for the coverage row.
--custom-dimensions <custom_dimensions>	text	—	'dim:member;dim:member' for the coverage row.
--index <index>	integer	—	Position (omit to append at end).
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs add-status

Add a StatusDefinition.

deepcell defs add-status <filename>

deepcell defs add-status model.deepcell --name Budget --ref budget --archetype budget --authority derived

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--name <name>	text	—	The status IDENTIFIER (@statusId), e.g. 'Forecast' — not a display label. Must satisfy the reference-id grammar. Set the readable name afterwards with `defs update-status --label`.
--ref <status_ref>	text	—	The status IDENTIFIER (@statusId) under the op's wire name, statusRef — the same thing as --name. If both are given, --ref wins.
--color <color>	text	—	(removed) color is a FormatDefinitions concern — see `deepcell defs add-format`.
--is-default	boolean	—	Mark as the document's default status — clears @isDefault from every other status.
--archetype <archetype>	text	—	What this status MEANS: actual \| preliminary \| restated \| estimate \| guidance \| consensus \| forecast \| budget \| plan \| target. Its realized/expected nature is derived from it. Omitting it leaves the meaning to be guessed from the id's spelling — see `deepcell ref status`.
--assurance <assurance>	text	—	Optional refinement: audited \| reviewed \| unaudited.
--authority <authority>	text	—	Optional refinement — who asserted the number: reported \| derived \| guidance \| consensus \| third_party.
--index <index>	integer	—	Position (omit to append at end).
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs apply

Apply a batch of ops atomically.

deepcell defs apply <filename>

deepcell defs apply model.deepcell --ops-file ops.json --dry-run

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--ops-file <ops_file>	filename	—	JSON file with an `ops` array (use '-' for stdin).
--ops <ops_inline>	text	—	Inline ops JSON (same shapes as --ops-file); mirrors the agent tool's `defs apply --ops '<json>'` form.
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs delete-axis-member

Remove a row or a column from a Block.

deepcell defs delete-axis-member <filename> --sheet <sheet_id> --block <block_id> --axis <axis> --ref <ref>

deepcell defs delete-axis-member model.deepcell --sheet variance --block revenue_table --axis rows --ref Gross_Profit

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--sheet <sheet_id>	text	required	Sheet containing the block.
--block <block_id>	text	required	blockId to edit.
--axis <axis>	rows \| columns	required	Which axis to edit: 'rows' (the block's @itemOrders) or 'columns' (its @contextRefs).
--ref <ref>	text	required	The item id or context id to remove.
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs delete-block

Delete a Block from a Sheet.

deepcell defs delete-block <filename> --sheet <sheet_id> --block <block_id>

deepcell defs delete-block model.deepcell --sheet <sheet_id> --block <block_id>

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--sheet <sheet_id>	text	required	Sheet containing the block.
--block <block_id>	text	required	blockId to delete.
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs delete-calc

Delete a CalculationDefinition by calcId.

deepcell defs delete-calc <filename> <calc_id>

deepcell defs delete-calc model.deepcell <calc_id>

Argument	Type	Required
filename	text	required
calc_id	text	required

Flag	Type	Default	What it does
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs delete-context

Delete a Context (period or non-temporal axis member).

deepcell defs delete-context <filename> <context_ref>

deepcell defs delete-context model.deepcell <context_ref>

Argument	Type	Required
filename	text	required
context_ref	text	required

Flag	Type	Default	What it does
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs delete-doc

Delete a Document and its body.

deepcell defs delete-doc <filename> <doc_id>

deepcell defs delete-doc model.deepcell <doc_id>

Argument	Type	Required
filename	text	required
doc_id	text	required

Flag	Type	Default	What it does
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs delete-format

Delete a <Format> by formatId.

deepcell defs delete-format <filename> <format_id>

deepcell defs delete-format model.deepcell <format_id>

Argument	Type	Required
filename	text	required
format_id	text	required

Flag	Type	Default	What it does
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs delete-item

Delete an item, and with --cascade its descendants too.

deepcell defs delete-item <filename> <item_id>

deepcell defs delete-item model.deepcell Revenue --cascade

Argument	Type	Required
filename	text	required
item_id	text	required

Flag	Type	Default	What it does
--cascade	boolean	—	Also delete all descendants.
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs delete-rule

Delete a <Rule> by index or by @target.

deepcell defs delete-rule <filename> <format_id>

deepcell defs delete-rule model.deepcell <format_id>

Argument	Type	Required
filename	text	required
format_id	text	required

Flag	Type	Default	What it does
--index <index>	integer	—	Delete the rule at this position.
--target <target>	text	—	Delete the first rule with this @target.
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs delete-scenario

Delete a ScenarioDefinition by its contextRef.

deepcell defs delete-scenario <filename> <scenario_ref>

deepcell defs delete-scenario model.deepcell <scenario_ref>

Argument	Type	Required
filename	text	required
scenario_ref	text	required

Flag	Type	Default	What it does
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs delete-sheet

Delete a presentation Sheet and every Block on it.

deepcell defs delete-sheet <filename> <sheet_id>

deepcell defs delete-sheet model.deepcell <sheet_id>

Argument	Type	Required
filename	text	required
sheet_id	text	required

Flag	Type	Default	What it does
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs delete-source

Remove a <Source>.

deepcell defs delete-source <filename> --id <source_id>

deepcell defs delete-source model.deepcell --id <source_id>

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--id <source_id>	text	required	sourceId to delete.
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs delete-status

Delete a StatusDefinition by its statusRef.

deepcell defs delete-status <filename> <status_ref>

deepcell defs delete-status model.deepcell <status_ref>

Argument	Type	Required
filename	text	required
status_ref	text	required

Flag	Type	Default	What it does
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs header set

Set or replace a Header property.

deepcell defs header set <filename> <key> <value>

deepcell defs header set model.deepcell <key> <value>

Argument	Type	Required
filename	text	required
key	text	required
value	text	required

Flag	Type	Default	What it does
--type <prop_type>	string \| number \| boolean \| datetime	string	Property type tag written into <Property @type>.
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs header unset

Delete a Header property.

deepcell defs header unset <filename> <key>

deepcell defs header unset model.deepcell <key>

Argument	Type	Required
filename	text	required
key	text	required

Flag	Type	Default	What it does
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs list

List what the document DEFINES: items, calcs, contexts, scenarios, statuses.

deepcell defs list <filename>

deepcell defs list model.deepcell

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--workspace <workspace_slug>	text	—	Override active workspace.

Exit codes: 0 — completed · 1 — read-only-check

defs rename-block

Change a Block's display name — its section heading in the render.

deepcell defs rename-block <filename> <new_name> --sheet <sheet_id> --block <block_id>

deepcell defs rename-block model.deepcell <new_name> --sheet <sheet_id> --block <block_id>

Argument	Type	Required
filename	text	required
new_name	text	required

Flag	Type	Default	What it does
--sheet <sheet_id>	text	required	Sheet containing the block.
--block <block_id>	text	required	blockId to rename.
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs rename-context

Rename a Context's @contextId; references cascade.

deepcell defs rename-context <filename> <context_ref> <new_name>

deepcell defs rename-context model.deepcell <context_ref> <new_name>

Argument	Type	Required
filename	text	required
context_ref	text	required
new_name	text	required

Flag	Type	Default	What it does
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs rename-dimension

Rename a custom Dimension's @dimensionId.

deepcell defs rename-dimension <filename> <dimension_id> <new_name>

deepcell defs rename-dimension model.deepcell <dimension_id> <new_name>

Argument	Type	Required
filename	text	required
dimension_id	text	required
new_name	text	required

Flag	Type	Default	What it does
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs rename-item

Rename an item's stable identifier; references cascade.

deepcell defs rename-item <filename> <item_id> <new_name>

deepcell defs rename-item model.deepcell Revenue Total_Revenue

Argument	Type	Required
filename	text	required
item_id	text	required
new_name	text	required

Flag	Type	Default	What it does
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs rename-member

Rename one Member's @memberId within a custom Dimension.

deepcell defs rename-member <filename> <dimension_id> <member_id> <new_name>

deepcell defs rename-member model.deepcell <dimension_id> <member_id> <new_name>

Argument	Type	Required
filename	text	required
dimension_id	text	required
member_id	text	required
new_name	text	required

Flag	Type	Default	What it does
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs rename-scenario

Rename a scenario's IDENTIFIER (@scenarioId); references cascade.

deepcell defs rename-scenario <filename> <scenario_ref> <new_name>

deepcell defs rename-scenario model.deepcell downside bear

Argument	Type	Required
filename	text	required
scenario_ref	text	required
new_name	text	required

Flag	Type	Default	What it does
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs rename-sheet

Change a Sheet's displayed tab label.

deepcell defs rename-sheet <filename> <sheet_id> <new_label>

deepcell defs rename-sheet model.deepcell <sheet_id> <new_label>

Argument	Type	Required
filename	text	required
sheet_id	text	required
new_label	text	required

Flag	Type	Default	What it does
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs rename-status

Change a status's IDENTIFIER (@statusId); references cascade.

deepcell defs rename-status <filename> <status_ref> <new_name>

deepcell defs rename-status model.deepcell <status_ref> <new_name>

Argument	Type	Required
filename	text	required
status_ref	text	required
new_name	text	required

Flag	Type	Default	What it does
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs reorder-axis-member

Move a row or a column to a new position within a Block.

deepcell defs reorder-axis-member <filename> --sheet <sheet_id> --block <block_id> --axis <axis> --ref <ref> --to-index <to_index>

deepcell defs reorder-axis-member model.deepcell --sheet variance --block revenue_table --axis rows --ref Gross_Profit --to-index 0

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--sheet <sheet_id>	text	required	Sheet containing the block.
--block <block_id>	text	required	blockId to edit.
--axis <axis>	rows \| columns	required	Which axis to edit: 'rows' (the block's @itemOrders) or 'columns' (its @contextRefs).
--ref <ref>	text	required	The item id or context id to move.
--to-index <to_index>	integer range	required	Final 0-based position on the axis. 0 = first row / leftmost column.
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs reorder-block

Move a Block to a new position within its Sheet.

deepcell defs reorder-block <filename> --sheet <sheet_id> --block <block_id> --to-index <to_index>

deepcell defs reorder-block model.deepcell --sheet variance --block revenue_table --to-index 0

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--sheet <sheet_id>	text	required	Sheet containing the block.
--block <block_id>	text	required	blockId to move.
--to-index <to_index>	integer range	required	Final 0-based position among the sheet's blocks. 0 = topmost.
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs reorder-contexts

Move a Context to a new position in the contexts list.

deepcell defs reorder-contexts <filename> <context_ref> <to_index>

deepcell defs reorder-contexts model.deepcell <context_ref> <to_index>

Argument	Type	Required
filename	text	required
context_ref	text	required
to_index	integer	required

Flag	Type	Default	What it does
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs reorder-item

Move an item to a new position among its siblings (final-position index).

deepcell defs reorder-item <filename> <item_id> --to-index <to_index>

deepcell defs reorder-item model.deepcell Revenue --to-index 0

Argument	Type	Required
filename	text	required
item_id	text	required

Flag	Type	Default	What it does
--to-index <to_index>	integer	required	Final 0-based position among the item's siblings. 0 = first. Lets you place a referenced item before its referencer (avoids a forward item-order reference).
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs reorder-scenarios

Move a scenario to a new position in the scenario list.

deepcell defs reorder-scenarios <filename> <scenario_ref> --to-index <to_index>

deepcell defs reorder-scenarios model.deepcell <scenario_ref> --to-index <to_index>

Argument	Type	Required
filename	text	required
scenario_ref	text	required

Flag	Type	Default	What it does
--to-index <to_index>	integer range	required	Final 0-based position among the scenarios. 0 = first.
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs reorder-sheets

Move a Sheet to a new position in the tab order.

deepcell defs reorder-sheets <filename> <sheet_id> --to-index <to_index>

deepcell defs reorder-sheets model.deepcell variance --to-index 0

Argument	Type	Required
filename	text	required
sheet_id	text	required

Flag	Type	Default	What it does
--to-index <to_index>	integer range	required	Final 0-based position among the sheets. 0 = leftmost tab.
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs set-block-attrs

Set presentation-layout attributes on an existing block.

deepcell defs set-block-attrs <filename> --sheet <sheet_id> --block <block_id>

deepcell defs set-block-attrs model.deepcell --sheet variance --block revenue_table --status-refs actual,budget --status-expansion columns

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--sheet <sheet_id>	text	required	Sheet containing the block.
--block <block_id>	text	required	blockId of the block to edit.
--format-ref <format_ref>	text	—	FormatDefinitions id this block resolves against. Pass an empty string to clear it back to the document default (the Format named default_format, else the first one defined). See `deepcell ref format`.
--status-expansion <status_expansion>	none \| columns \| series	—	Side-by-side status-column layout. 'columns' lays each status in --status-refs out as its own run of context columns; 'series' is the chart form, one series per status; 'none' (default) keeps the single-column-per-context layout.
--status-refs <status_refs>	text	—	Whitespace/comma-separated status ids to expand into columns (e.g. "actual budget"). Required for --status-expansion=columns.
--dim-expansion <dim_expansion>	none \| rows \| series	—	Custom-dimension member sub-rows. 'rows' lays each member of --dim-ref out as a contiguous sub-row under its item; 'series' is the chart form, one series per member; 'none' (default) keeps the one-row-per-item layout.
--dim-ref <dim_ref>	text	—	Dimension id whose members are expanded into sub-rows (e.g. "geography"). Required for --dim-expansion=rows.
--dim-expansion-cap <dim_expansion_cap>	integer range	—	Max members to expand into sub-rows before falling back to a single row (positive int; default 24). Used with --dim-expansion=rows.
--dim-member-refs <dim_member_refs>	text	—	Whitespace/comma-separated member ids of --dim-ref, order preserved. With --dim-expansion it selects which members expand; without one, a single id pins that member for every cell the block reads — how a chart plots one slice of a dimension-sliced item.
--dim-filter <dim_filter>	text	—	Pin the dimensions the block does NOT expand, one member each: 'region:na;cohort:c1'. Same dim:member spelling and ';' separator as customDimensions on a Value, so a stored coordinate can be copied across. A block expands one dimension (--dim-ref), so this is what makes a cell keyed on two or more custom dimensions addressable.
--scenario-expansion <scenario_expansion>	none \| columns \| series	—	Side-by-side scenario-column layout. 'columns' lays each scenario in --scenario-refs out as its own run of context columns; 'series' is the chart form, one series per scenario; 'none' (default) keeps the single-column-per-context layout.
--scenario-refs <scenario_refs>	text	—	Whitespace/comma-separated scenario ids to expand into columns (e.g. "Base Bull"). Required for --scenario-expansion=columns.
--chart-type <chart_type>	bar \| bar_stacked \| bar_horizontal \| line \| area \| pie \| donut \| waterfall \| range_bar \| scatter	—	Chart type (chart blocks only). 'waterfall' bridges deltas between declared totals; 'range_bar' draws a low..high band per category (the football field).
--category-axis <category_axis>	context \| item	—	Which dimension is the category axis (chart blocks only).
--total-item-refs <total_item_refs>	text	—	Whitespace/comma-separated refs naming the plotted categories that rest on the baseline instead of floating on the running sum (--chart-type=waterfall only). Declared, never inferred: omit it and every step is a delta.
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs set-format

Set cell/row/column formatting (resolves the governing <Format>).

deepcell defs set-format <filename> --sheet-id <sheet_id> --item-ref <item_ref> --scope <scope>

deepcell defs set-format model.deepcell --sheet-id ic --block-id deal_summary --item-ref Entry_Multiple --scope item --number-format '0.0x' --bold

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--sheet-id <sheet_id>	text	required	Sheet id of the cell.
--block-id <block_id>	text	—	Governing block id (resolves @formatRef).
--item-ref <item_ref>	text	required	Item ref of the cell.
--context-ref <context_ref>	text	—	Context ref (required for cell/column scope).
--scope <scope>	cell \| item \| context	required	cell:ITEM:CONTEXT \| item:ITEM \| context:CONTEXT
--number-format <number_format>	text	—	Excel pattern, e.g. '#,##0'.
--font-name <font_name>	text	—	Font family name.
--font-size <font_size>	float	—	Font size in points.
--bold	boolean	—	Set/clear bold.
--italic	boolean	—	Set/clear italic.
--fg-color <fg_color>	text	—	Text hex '#RRGGBB'.
--bg-color <bg_color>	text	—	Fill hex '#RRGGBB'.
--text-align <text_align>	text	—	'left'\|'center'\|'right'.
--indent <indent>	integer	—	Indent character count.
--border-top <border_top>	text	—	e.g. 'thin #000000'.
--border-bottom <border_bottom>	text	—	Bottom border, e.g. 'thin #000000' (style + optional hex color).
--border-left <border_left>	text	—	Left border, e.g. 'thin #000000' (style + optional hex color).
--border-right <border_right>	text	—	Right border, e.g. 'thin #000000' (style + optional hex color).
--clear <clear>	text	—	Token name to revert to inherit (repeatable).
--clear-all	boolean	—	Delete the target's rule entirely.
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs set-source-cites

Replace which cells a <Source> backs.

deepcell defs set-source-cites <filename> --id <source_id>

deepcell defs set-source-cites model.deepcell --id <source_id>

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--id <source_id>	text	required	sourceId whose coverage to replace.
--items <item_refs>	text	—	CSV of itemRefs this source backs.
--contexts <context_refs>	text	—	CSV of contextRefs. Omit to cover every context the statusRef allows.
--status <status_ref>	text	—	statusRef for the coverage row.
--scenario <scenario_ref>	text	—	scenarioRef for the coverage row.
--custom-dimensions <custom_dimensions>	text	—	'dim:member;dim:member' for the coverage row.
--at <at>	text	—	Position override for this coverage row.
--clear	boolean	—	Remove every coverage row instead of setting one.
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs show

Show one item's ItemDef and every CalcDef that governs it.

deepcell defs show <filename> <item_id>

deepcell defs show model.deepcell Revenue

Argument	Type	Required
filename	text	required
item_id	text	required

Flag	Type	Default	What it does
--workspace <workspace_slug>	text	—	Override active workspace.

Exit codes: 0 — completed · 1 — read-only-check

defs update-calc

Patch a CalcDef; only the fields you pass are changed.

deepcell defs update-calc <filename> <calc_id>

deepcell defs update-calc model.deepcell calc_revenue --formula 'Units_Sold[CURRENT] * Unit_Price[CURRENT] * 1.02'

Argument	Type	Required
filename	text	required
calc_id	text	required

Flag	Type	Default	What it does
--formula <formula>	text	—	Replace the formula.
--context <context_ref>	text	—	Change contextRef.
--scenario <scenario_ref>	text	—	Change scenarioRef.
--status <status_ref>	text	—	Change statusRef (e.g. 'projected'). Pass '' to clear.
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs update-context

Patch a Context's name / status / kind; only fields you pass are sent.

deepcell defs update-context <filename> <context_ref>

deepcell defs update-context model.deepcell FY2025 --state closed --as-of 2025-12-31

Argument	Type	Required
filename	text	required
context_ref	text	required

Flag	Type	Default	What it does
--name <name>	text	—	Rename the contextId; references cascade. NOT the display name — see --label.
--label <new_label>	text	—	Change the context's DISPLAY LABEL (emits set_context_label). The contextId is untouched — use --name to change the identifier.
--status <status_ref>	text	—	Set statusRef.
--clear-status	boolean	—	Clear statusRef (explicit-null).
--kind <kind>	text	—	Context kind. Omit / null / 'period' / temporal alias collapses to canonical 'period'; any other snake_case label marks a non-temporal context. Always written to @kind.
--state <state>	text	—	Period state: closed \| open \| future. This is what says whether the period is over — the question the A/E suffix on a context id used to answer by accident. Only meaningful for --kind period.
--as-of <as_of>	text	—	ISO YYYY-MM-DD the period's numbers are stated as of. Documentation and lint input only; never consulted when rendering.
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs update-doc

Update a Document's attributes.

deepcell defs update-doc <filename> <doc_id>

deepcell defs update-doc model.deepcell <doc_id>

Argument	Type	Required
filename	text	required
doc_id	text	required

Flag	Type	Default	What it does
--name <name>	text	—	New display title.
--lang <lang>	text	—	New BCP-47 language tag.
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs update-format

Rename a <Format> and/or toggle its IB-default inheritance.

deepcell defs update-format <filename> <format_id>

deepcell defs update-format model.deepcell <format_id>

Argument	Type	Required
filename	text	required
format_id	text	required

Flag	Type	Default	What it does
--new-id <new_id>	text	—	New formatId; cascades through every <Block @formatRef>.
--inherit	boolean	—	Toggle the IB default base. --no-inherit makes this a total custom theme (@inherit="false"); --inherit returns to the add-on default. See `deepcell ref format`.
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs update-item

Patch an item; only fields you pass are sent.

deepcell defs update-item <filename> <item_id>

deepcell defs update-item model.deepcell Revenue --scale 3 --currency USD

Argument	Type	Required
filename	text	required
item_id	text	required

Flag	Type	Default	What it does
--name <name>	text	—	Rename the itemId; references cascade. Equivalent to `defs rename-item`.
--label <new_label>	text	—	Change the item's DISPLAY LABEL (emits set_item_label). The itemId is untouched — use `defs rename-item` to change the identifier. Rewrites the text of the item's first <Label> and keeps its lang; other locales are left alone and cannot be added here.
--level <level>	integer	—	Change hierarchy level.
--parent <parent_item_id>	text	—	Change parent itemId.
--clear-parent	boolean	—	Make item a root (explicit-null parentItemId).
--data-type <data_type>	text	—	Set DataType element (e.g. 'monetary', 'percentage', 'number').
--unit <unit>	text	—	Set Unit element (e.g. '%', 'hours', 'tonnes').
--scale <scale>	integer	—	Set Scale element.
--currency <currency>	text	—	Set Currency element (ISO code).
--clear-data-type	boolean	—	Remove the DataType element (explicit-null).
--clear-unit	boolean	—	Remove the Unit element (explicit-null).
--clear-scale	boolean	—	Remove the Scale element (explicit-null).
--clear-currency	boolean	—	Remove the Currency element (explicit-null).
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs update-scenario

Patch a scenario; only the fields you pass are sent.

deepcell defs update-scenario <filename> <scenario_ref>

deepcell defs update-scenario model.deepcell downside --label 'Bear case'

Argument	Type	Required
filename	text	required
scenario_ref	text	required

Flag	Type	Default	What it does
--name <name>	text	—	Rename the scenarioId; references cascade. Equivalent to `defs rename-scenario`. NOT the display name — see --label.
--label <new_label>	text	—	Change the scenario's DISPLAY LABEL (emits set_scenario_label). The scenarioId is untouched — use --name to change the identifier.
--is-default	boolean	—	Make this the document's default scenario (clears @isDefault from every other scenario), or strip the flag from this one.
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs update-sensitivity

Edit a sensitivity block's name, format, or axes/outputs.

deepcell defs update-sensitivity <filename> --sheet <sheet_id> --block <block_id>

deepcell defs update-sensitivity model.deepcell --sheet <sheet_id> --block <block_id>

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--sheet <sheet_id>	text	required	Sheet containing the block.
--block <block_id>	text	required	blockId of the block to edit.
--name <name>	text	—	New display name.
--format-ref <format_ref>	text	—	New FormatDefinitions id.
--spec-file <spec_file>	filename	—	JSON with {"axes": [...], "outputs": [...]} to replace both.
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs update-source

Change fields on a <Source>.

deepcell defs update-source <filename> --id <source_id>

deepcell defs update-source model.deepcell --id <source_id>

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--id <source_id>	text	required	sourceId to update.
--kind <kind>	text	—	New @kind (closed set).
--role <role>	text	—	New @role (free text).
--reach <reach>	text	—	public \| account \| private \| offline.
--title <title>	text	—	New title. Pass '' to clear.
--locator <locator>	text	—	New locator. Pass '' to clear.
--description <description>	text	—	New description. Pass '' to clear.
--at <at>	text	—	New default position.
--effective-date <effective_date>	text	—	New effective date.
--retrieved-at <retrieved_at>	text	—	New retrieval timestamp.
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

defs update-status

Patch a status; only the fields you pass are sent.

deepcell defs update-status <filename> <status_ref>

deepcell defs update-status model.deepcell budget --archetype budget --label Budget

Argument	Type	Required
filename	text	required
status_ref	text	required

Flag	Type	Default	What it does
--name <name>	text	—	Rename the statusId; references cascade. Equivalent to `defs rename-status`. NOT the display name — see --label.
--label <new_label>	text	—	Change the status's DISPLAY LABEL (emits set_status_label). The statusId is untouched — use --name to change the identifier.
--is-default	boolean	—	Make this the document's default status (clears @isDefault from every other status), or strip the flag from this one.
--archetype <archetype>	text	—	What this status MEANS: actual \| preliminary \| restated \| estimate \| guidance \| consensus \| forecast \| budget \| plan \| target. Pass an empty string to clear it (and fall back to inference).
--assurance <assurance>	text	—	audited \| reviewed \| unaudited.
--authority <authority>	text	—	reported \| derived \| guidance \| consensus \| third_party.
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.
--dry-run	boolean	—	Validate only: run the full server-side pipeline (per-op validation, formula parse, post-apply cycle check + recompute) and report errors without persisting anything — no commit, no revision bump.

Exit codes: 0 — completed · 1 — nothing-changed

doc backlinks

Show what cites a reference: prose, slides and reasoning, this file only.

deepcell doc backlinks <filename> --target <target>

deepcell doc backlinks model.deepcell --target <target>

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--target <target>	text	required	Reference to invert, e.g. 'claim/t_hold'.

Exit codes: 0 — completed

doc blocks

List every block and the id it can be edited by.

deepcell doc blocks <filename>

deepcell doc blocks model.deepcell

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--doc <doc_id>	text	—	Document ID (default: the first).

Exit codes: 0 — completed

doc delete-block

Delete one block.

deepcell doc delete-block <filename> --doc <doc_id> --block <block_id>

deepcell doc delete-block model.deepcell --doc <doc_id> --block <block_id>

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--doc <doc_id>	text	required	Document ID.
--block <block_id>	text	required	Block id to delete.
--rationale <rationale>	text	—	Commit message recording why.
--revision <revision>	text	—	Compare-and-swap token from `cat`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.

Exit codes: 0 — completed

doc insert-block

Insert a new block after another one, or at the top of the document.

deepcell doc insert-block <filename> --doc <doc_id> --markdown-file <markdown_file>

deepcell doc insert-block model.deepcell --doc <doc_id> --markdown-file <markdown_file>

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--doc <doc_id>	text	required	Document ID.
--after <after_block_id>	text	—	Insert after this block id. Omit to insert at the top.
--markdown-file <markdown_file>	file	required	File holding the new block's markdown.
--rationale <rationale>	text	—	Commit message recording why.
--revision <revision>	text	—	Compare-and-swap token from `cat`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.

Exit codes: 0 — completed

doc links

List every deepcell: reference, and whether it resolved.

deepcell doc links <filename>

deepcell doc links model.deepcell --doc variance_note --unresolved

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--doc <doc_id>	text	—	Restrict to one document.
--unresolved	boolean	—	Only references that did not resolve.

Exit codes: 0 — completed

doc lint

Check a document's references.

deepcell doc lint <filename>

deepcell doc lint model.deepcell --doc variance_note --strict

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--doc <doc_id>	text	—	Restrict to one document.
--strict	boolean	—	Also flag numerals that match a modelled value but are typed, not linked.

Exit codes: 0 — completed

doc list

List every <Document> in the file.

deepcell doc list <filename>

deepcell doc list model.deepcell

Argument	Type	Required
filename	text	required

Exit codes: 0 — completed

doc move-block

Move a block after another one, or to the top.

deepcell doc move-block <filename> --doc <doc_id> --block <block_id>

deepcell doc move-block model.deepcell --doc <doc_id> --block <block_id>

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--doc <doc_id>	text	required	Document ID.
--block <block_id>	text	required	Block id to move.
--after <after_block_id>	text	—	Move after this block id. Omit to move to the top.
--rationale <rationale>	text	—	Commit message recording why.
--revision <revision>	text	—	Compare-and-swap token from `cat`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.

Exit codes: 0 — completed

doc outline

Print the headings and the anchor each one is addressable by.

deepcell doc outline <filename>

deepcell doc outline model.deepcell --doc variance_note

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--doc <doc_id>	text	—	Document ID (default: the first).

Exit codes: 0 — completed

doc patch-body

Replace one anchored section of a document.

deepcell doc patch-body <filename> --doc <doc_id> --anchor <anchor> --markdown <markdown>

deepcell doc patch-body model.deepcell --doc variance_note --anchor outlook --markdown '## Outlook {#outlook}\n\nQ4 pipeline covers the gap.'

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--doc <doc_id>	text	required	Document ID.
--anchor <anchor>	text	required	Explicit {#id} anchor of the section to replace.
--markdown <markdown>	text	required	Replacement markdown for that section.
--notation <notation>	markdown \| text	—	What the body IS. Omitted keeps whatever the document already declared, so editing text never retypes it.
--rationale <rationale>	text	—	Commit message recording why.
--revision <revision>	text	—	Compare-and-swap token from `cat`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.

Exit codes: 0 — completed

doc replace-block

Replace one block, addressed by its id.

deepcell doc replace-block <filename> --doc <doc_id> --block <block_id> --markdown-file <markdown_file>

deepcell doc replace-block model.deepcell --doc <doc_id> --block <block_id> --markdown-file <markdown_file>

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--doc <doc_id>	text	required	Document ID.
--block <block_id>	text	required	Block id from `deepcell doc blocks`.
--markdown-file <markdown_file>	file	required	File holding the replacement markdown.
--rationale <rationale>	text	—	Commit message recording why.
--revision <revision>	text	—	Compare-and-swap token from `cat`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.

Exit codes: 0 — completed

doc set-body

Replace a document's whole body.

deepcell doc set-body <filename> --doc <doc_id> --body-file <body_file>

deepcell doc set-body model.deepcell --doc variance_note --body-file variance-note.md -m 'Rewrite the July variance note'

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--doc <doc_id>	text	required	Document ID.
--body-file <body_file>	file	required	File holding the new body.
--notation <notation>	markdown \| text	—	What the body IS. Omitted keeps whatever the document already declared, so editing text never retypes it.
--rationale <rationale>	text	—	Commit message recording why.
--revision <revision>	text	—	Compare-and-swap token from `cat` (refuses if the file moved).
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.

Exit codes: 0 — completed

doc set-notation

Say what a document's body IS, without touching a byte of it.

deepcell doc set-notation <filename> --doc <doc_id> --notation <notation>

deepcell doc set-notation model.deepcell --doc <doc_id> --notation <notation>

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--doc <doc_id>	text	required	Document ID.
--notation <notation>	markdown \| text	required	What the body IS.
--rationale <rationale>	text	—	Commit message recording why.
--revision <revision>	text	—	Compare-and-swap token from `cat`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.

Exit codes: 0 — completed

doc show

Print one document.

deepcell doc show <filename>

deepcell doc show model.deepcell --doc variance_note --as markdown

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--doc <doc_id>	text	—	Document ID (default: the first).
--scenario <scenario_id>	text	—	Scenario to resolve values under.
--as <rendering>	text \| markdown	text	markdown keeps the [[deepcell:...]] source; text shows resolved values.
--with-ids	boolean	—	Prefix each block with the id it can be edited by.

Exit codes: 0 — completed

doc stamp-ids

Give every block without an id a stable `{#id}`, so it can be edited.

deepcell doc stamp-ids <filename> --doc <doc_id>

deepcell doc stamp-ids model.deepcell --doc <doc_id>

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--doc <doc_id>	text	required	Document ID.
--rationale <rationale>	text	—	Commit message recording why.
--revision <revision>	text	—	Compare-and-swap token from `cat`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.

Exit codes: 0 — completed

edit

Write literal cell values (assumptions, historical actuals).

deepcell edit <filename> [item_ref] [context_ref] [new_value]

deepcell edit model.deepcell Growth_Rate FY2026E 0.12

Argument	Type	Required
filename	text	required
item_ref	text	optional
context_ref	text	optional
new_value	text	optional

Flag	Type	Default	What it does
--force	boolean	—	Type over a calculated cell, REMOVING the formula that computed it (no in-document undo).
--clear	boolean	—	Remove the literal value cell (NEW_VALUE omitted) so a CalcDef can re-govern it.
--status <status_ref>	text	—	Status reference (e.g. 'projected').
--scenario <scenario_ref>	text	—	Scenario dimension — must be a defined scenarioId (omit for the base cell).
--custom-dimensions <custom_dimensions>	text	—	Custom dimensions as 'dim:member;dim:member', e.g. 'geography:na;product_line:ent'.
--batch <batch_file>	text	—	Batch edits as a JSON file path, '-' for stdin, or inline JSON (a value starting with '[' or '{').
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--rationale <commit_message>	text	—	Why this edit was made. Written as the commit message body (and a trailer), so history reads as the decision instead of '[batch-edit] Item[Ctx]'. Sent as `rationale`; `-m` / `--message` are aliases of `--rationale`.
--title <commit_title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'.
--auto-create-context	boolean	—	Auto-create missing context definitions.
--replace	boolean	—	DEPRECATED alias for `deepcell replace FILE OLD NEW` — still works, will be removed in a future release. Note the exit codes listed here are `edit`'s: in replace mode, exit 1 means the replacement IS already in the file and the document is invalid.
--replace-all	boolean	—	Replace all occurrences (with the deprecated --replace).
--workspace <workspace_slug>	text	—	Override active workspace.

Exit codes: 0 — completed · 1 — partial

reasoning add-argument

Add a new <Argument> edge to FILENAME's <Reasoning> section.

deepcell reasoning add-argument <filename> --from-id <from_id> --to-id <to_id> --rel <rel>

deepcell reasoning add-argument model.deepcell --from-id r_pricing --to-id t_gm --rel refutes --weight 0.6

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--from-id <from_id>	text	required	Source node id.
--to-id <to_id>	text	required	Target node id.
--rel <rel>	supports \| refutes \| depends_on \| derives_from \| variant_of \| supersedes \| contradicts \| references \| answers	required	How --from-id relates to --to-id: supports / refutes (evidential), depends_on (falsifying the target falsifies the source), derives_from (computed or inferred from it), answers (this conclusion settles that question), variant_of (your view vs a consensus claim), supersedes (replaces an older node), contradicts, references. See `deepcell ref rel`.
--id <arg_id>	text	—	Argument id (auto-generated if omitted).
--weight <weight>	float	—	How much this edge carries, 0-1 (optional).
--body <body>	text	—	<Body> text.
--body-file <body_file>	file	—	File holding the <Body> text; '-' reads stdin. Prefer this over --body for text containing '$' — inline shell arguments mangle dollar amounts.
--body-notation <body_notation>	markdown \| text	—	What the <Body> IS: markdown or literal text. Declared, never sniffed — no reader guesses from the bytes. Omitted leaves it as it was.
--status <status>	text	—	Argument lifecycle status (active/superseded/revoked).
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.

Exit codes: 0 — completed · 1 — written-but-invalid

reasoning add-assumption

Add a new <Assumption> to FILENAME's <Reasoning> section.

deepcell reasoning add-assumption <filename> --id <assumption_id>

deepcell reasoning add-assumption model.deepcell --id a_hiring --label 'Hiring lands on plan' --body 'Sales headcount reaches 40 by Q3.' --item-refs Headcount

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--id <assumption_id>	text	required	New Assumption id.
--label <label>	text	—	<Label> text. The finding itself, not the subject it concerns — "Working capital is a source of cash", not "Working capital". Renders as the reasoning outline row, and a Deck may bind it as a slide headline.
--label-file <label_file>	file	—	File holding the <Label> text; '-' reads stdin. Prefer this over --label for text containing '$' — inline shell arguments mangle dollar amounts.
--body <body>	text	—	<Body> text.
--body-file <body_file>	file	—	File holding the <Body> text; '-' reads stdin. Prefer this over --body for text containing '$' — inline shell arguments mangle dollar amounts.
--body-notation <body_notation>	markdown \| text	—	What the <Body> IS: markdown or literal text. Declared, never sniffed — no reader guesses from the bytes. Omitted leaves it as it was.
--status-ref <status_ref>	text	—	Model Status dimension id (e.g. actual / projected) — NOT the assumption's lifecycle state (that is --status).
--calc-ref <calc_ref>	text	—	CalcDef id anchoring this assumption to a formula in the model.
--item-refs <item_refs>	text	—	Comma-separated item ids the assumption constrains. When a Spreadsheet exists, omitting it triggers unanchored_assumption because the premise cannot be item-impact-traced as actuals drift in. A qualitative no-grid file and macro assumptions may legitimately omit it.
--confidence <confidence>	float	—	How strongly you hold this assumption, 0-1.
--status <status>	holding \| uncertain \| broken \| superseded	—	Assumption lifecycle state: holding until something contradicts it, broken once actuals do, superseded when a newer assumption replaces it.
--verified-at <verified_at>	text	—	ISO date (YYYY-MM-DD) this assumption was last confirmed to still hold (@verifiedAt). Records WHEN it was checked; --status holding records that it stands.
--broken-at <broken_at>	text	—	ISO date (YYYY-MM-DD) this assumption was found no longer to hold (@brokenAt). Records WHEN it failed; --status broken records THAT it failed — set both when actuals contradict an assumption.
--parent-claim-ref <parent_claim_ref>	text	—	Claim id this assumption hangs under (hierarchy, not an Argument edge).
--context-refs <context_refs>	text	—	Comma-separated context (period) ids this node reasons across.
--scenario-ref <scenario_ref>	text	—	Scenario id this node is about, when it holds only in one world.
--custom-dimensions <custom_dimensions>	text	—	Custom dimension members as `dim:member;dim2:member2` — the fifth axis of the anchor (e.g. `region:emea`).
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.

Exit codes: 0 — completed · 1 — written-but-invalid

reasoning add-claim

Add a new <Claim> to FILENAME's <Reasoning> section.

deepcell reasoning add-claim <filename> --id <claim_id> --kind <kind>

deepcell reasoning add-claim model.deepcell --id t_gm --kind thesis --label 'Gross margin expands' --body 'Mix shift to subscription lifts GM 200bps.' --item-refs Gross_Margin_Pct --confidence 0.62

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--id <claim_id>	text	required	New Claim id.
--kind <kind>	thesis \| risk \| catalyst \| counter \| question \| market_consensus	required	What the claim is: thesis (what you conclude), risk / catalyst (what moves it, needs --probability), counter (the case against), question (open), market_consensus (someone else's view, needs --attribution). See `deepcell guide revise/reasoning`.
--label <label>	text	—	<Label> text. The finding itself, not the subject it concerns — "Working capital is a source of cash", not "Working capital". Renders as the reasoning outline row, and a Deck may bind it as a slide headline.
--label-file <label_file>	file	—	File holding the <Label> text; '-' reads stdin. Prefer this over --label for text containing '$' — inline shell arguments mangle dollar amounts.
--body <body>	text	—	<Body> text.
--body-file <body_file>	file	—	File holding the <Body> text; '-' reads stdin. Prefer this over --body for text containing '$' — inline shell arguments mangle dollar amounts.
--body-notation <body_notation>	markdown \| text	—	What the <Body> IS: markdown or literal text. Declared, never sniffed — no reader guesses from the bytes. Omitted leaves it as it was.
--status-ref <status_ref>	text	—	Model Status dimension id (e.g. actual / projected) — NOT the claim lifecycle state (that is --status).
--calc-ref <calc_ref>	text	—	CalcDef id anchoring this claim to a formula in the model.
--item-refs <item_refs>	text	—	Comma-separated item ids anchoring this claim to a Spreadsheet. When Items exist, thesis/risk/catalyst claims need --item-refs or --calc-ref, else unanchored_claim warns (they become invisible to reasoning-diff and item-scoped queries). A qualitative no-grid file does not invent Items; question/market_consensus are always exempt.
--probability <probability>	float	—	Likelihood, 0-1 (required for kind=risk / catalyst).
--severity <severity>	low \| med \| high	—	Qualitative impact (required for kind=risk).
--confidence <confidence>	float	—	How strongly you hold this claim, 0-1.
--strength <strength>	low \| med \| high	—	How strongly the claim is held, qualitatively. Independent of --confidence (the numeric form); a claim may carry both.
--parent-claim-ref <parent_claim_ref>	text	—	Claim id this one hangs under (hierarchy, not an Argument edge).
--attribution <attribution>	text	—	Who holds this view (required for kind=market_consensus), e.g. 'Bloomberg consensus, 2026-07'.
--status <status>	draft \| active \| superseded \| falsified \| revoked	—	Claim lifecycle state — NOT the model's Status dimension (that is --status-ref).
--context-refs <context_refs>	text	—	Comma-separated context (period) ids this node reasons across.
--scenario-ref <scenario_ref>	text	—	Scenario id this node is about, when it holds only in one world.
--custom-dimensions <custom_dimensions>	text	—	Custom dimension members as `dim:member;dim2:member2` — the fifth axis of the anchor (e.g. `region:emea`).
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.

Exit codes: 0 — completed · 1 — written-but-invalid

reasoning add-evidence

Add a new <Evidence> to FILENAME's <Reasoning> section.

deepcell reasoning add-evidence <filename> --id <evidence_id> --source-ref <source_ref>

deepcell reasoning add-evidence model.deepcell --id e_10k --source-ref src_aapl_10k_fy25 --excerpt 'Gross margin of 46.2%' --retrieved-at 2026-02-19T10:30:00Z

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--id <evidence_id>	text	required	New Evidence id.
--source-ref <source_ref>	text	required	sourceId of a <Source> in <SourceDefinitions>.
--excerpt <excerpt>	text	—	<Excerpt> text.
--excerpt-file <excerpt_file>	file	—	File holding the <Excerpt> text; '-' reads stdin. Prefer this over --excerpt for text containing '$' — inline shell arguments mangle dollar amounts.
--at <at>	text	—	Position in the source (page:47, t:00:14:32, text:HEADING).
--reliability <reliability>	text	—	primary \| secondary \| tertiary.
--effective-date <effective_date>	text	—	ISO8601 date.
--retrieved-at <retrieved_at>	text	—	ISO8601 date.
--item-refs <item_refs>	text	—	Comma-separated item ids this evidence bears on. Anchoring it here is what lets `reasoning impact` reach the evidence when one of those items moves; `update-evidence` can retrofit it later.
--status-ref <status_ref>	text	—	Model Status dimension id (e.g. actual / projected) the evidence speaks to.
--context-refs <context_refs>	text	—	Comma-separated context (period) ids this node reasons across.
--scenario-ref <scenario_ref>	text	—	Scenario id this node is about, when it holds only in one world.
--custom-dimensions <custom_dimensions>	text	—	Custom dimension members as `dim:member;dim2:member2` — the fifth axis of the anchor (e.g. `region:emea`).
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.

Exit codes: 0 — completed · 1 — written-but-invalid

reasoning apply

Apply a batch of reasoning ops atomically.

deepcell reasoning apply <filename>

deepcell reasoning apply model.deepcell

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--ops-file <ops_file>	filename	—	JSON file with an `ops` array (use '-' for stdin).
--ops <ops_inline>	text	—	Inline ops JSON (same shapes as --ops-file).
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.

Exit codes: 0 — completed

reasoning delete-argument

Delete one <Argument> edge from FILENAME's <Reasoning> section.

deepcell reasoning delete-argument <filename> [argument_id]

deepcell reasoning delete-argument model.deepcell --from-id r_pricing --edge-rel refutes --to-id t_gm

Argument	Type	Required
filename	text	required
argument_id	text	optional

Flag	Type	Default	What it does
--from-id <from_id>	text	—	Address: the edge's @from.
--edge-rel <edge_rel>	supports \| refutes \| depends_on \| derives_from \| variant_of \| supersedes \| contradicts \| references \| answers	—	Address: the edge's @rel.
--to-id <to_id>	text	—	Address: the edge's @to.
--cascade	boolean	—	Also remove every Argument touching the node (default). --no-cascade keeps them, and is refused with code=would_dangle unless you also pass --allow-dangling — a dangling edge lints, and is still addressable by its (from, rel, to) or its id, so it can be cleaned up later.
--allow-dangling	boolean	—	With --no-cascade, permit the delete even though it orphans Arguments.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.

Exit codes: 0 — completed · 1 — written-but-invalid

reasoning delete-assumption

Delete the <Assumption> NODE_ID from FILENAME's <Reasoning> section.

deepcell reasoning delete-assumption <filename> <node_id>

deepcell reasoning delete-assumption model.deepcell <node_id>

Argument	Type	Required
filename	text	required
node_id	text	required

Flag	Type	Default	What it does
--cascade	boolean	—	Also remove every Argument touching the node (default). --no-cascade keeps them, and is refused with code=would_dangle unless you also pass --allow-dangling — a dangling edge lints, and is still addressable by its (from, rel, to) or its id, so it can be cleaned up later.
--allow-dangling	boolean	—	With --no-cascade, permit the delete even though it orphans Arguments.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.

Exit codes: 0 — completed · 1 — written-but-invalid

reasoning delete-claim

Delete the <Claim> NODE_ID from FILENAME's <Reasoning> section.

deepcell reasoning delete-claim <filename> <node_id>

deepcell reasoning delete-claim model.deepcell t_gm --cascade

Argument	Type	Required
filename	text	required
node_id	text	required

Flag	Type	Default	What it does
--cascade	boolean	—	Also remove every Argument touching the node (default). --no-cascade keeps them, and is refused with code=would_dangle unless you also pass --allow-dangling — a dangling edge lints, and is still addressable by its (from, rel, to) or its id, so it can be cleaned up later.
--allow-dangling	boolean	—	With --no-cascade, permit the delete even though it orphans Arguments.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.

Exit codes: 0 — completed · 1 — written-but-invalid

reasoning delete-evidence

Delete the <Evidence> NODE_ID from FILENAME's <Reasoning> section.

deepcell reasoning delete-evidence <filename> <node_id>

deepcell reasoning delete-evidence model.deepcell <node_id>

Argument	Type	Required
filename	text	required
node_id	text	required

Flag	Type	Default	What it does
--cascade	boolean	—	Also remove every Argument touching the node (default). --no-cascade keeps them, and is refused with code=would_dangle unless you also pass --allow-dangling — a dangling edge lints, and is still addressable by its (from, rel, to) or its id, so it can be cleaned up later.
--allow-dangling	boolean	—	With --no-cascade, permit the delete even though it orphans Arguments.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.

Exit codes: 0 — completed · 1 — written-but-invalid

reasoning graph

Render the Argument graph from FILENAME as Mermaid (default) or DOT.

deepcell reasoning graph <filename>

deepcell reasoning graph model.deepcell --syntax mermaid

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--syntax <graph_syntax>	mermaid \| dot	mermaid	Graph syntax to emit. Use the global -f json for the raw graph payload.

Exit codes: 0 — completed

reasoning impact

Walk Argument edges from CLAIM_ID and list downstream nodes affected if it's falsified.

deepcell reasoning impact <filename> <claim_id>

deepcell reasoning impact model.deepcell a_hiring

Argument	Type	Required
filename	text	required
claim_id	text	required

Exit codes: 0 — completed

reasoning lint

Lint the <Reasoning> section of FILENAME for structural issues.

deepcell reasoning lint <filename>

deepcell reasoning lint model.deepcell --strict

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--strict	boolean	—	Exit non-zero on warn-level findings too (default: only error-level findings fail).

Exit codes: 0 — completed · 1 — read-only-check

reasoning set-conclusion

Declare which Claim is FILENAME's main conclusion.

deepcell reasoning set-conclusion <filename> [claim_id]

deepcell reasoning set-conclusion model.deepcell t_gm

Argument	Type	Required
filename	text	required
claim_id	text	optional

Flag	Type	Default	What it does
--clear	boolean	—	Remove the declaration and fall back to deriving the apex from the argument topology.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.

Exit codes: 0 — completed · 1 — written-but-invalid

reasoning set-exhibit

Declare which deck or slide to show beside FILENAME's conclusion.

deepcell reasoning set-exhibit <filename> [exhibit_ref]

deepcell reasoning set-exhibit model.deepcell

Argument	Type	Required
filename	text	required
exhibit_ref	text	optional

Flag	Type	Default	What it does
--clear	boolean	—	Remove the declaration. The conclusion then renders full width.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.

Exit codes: 0 — completed

reasoning set-key-question

Declare which question FILENAME exists to answer.

deepcell reasoning set-key-question <filename> [claim_id]

deepcell reasoning set-key-question model.deepcell

Argument	Type	Required
filename	text	required
claim_id	text	optional

Flag	Type	Default	What it does
--clear	boolean	—	Remove the declaration. The header then falls back to the `answers` edge off the conclusion, then to the document's only question, and otherwise shows nothing.
--needs-review	boolean	—	Mark the question as inferred rather than stated, so it renders as provisional until someone confirms it. Declaring without this flag clears it.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.

Exit codes: 0 — completed

reasoning supersede-assumption

Replace ASSUMPTION_ID with a new Assumption, keeping the old as history.

deepcell reasoning supersede-assumption <filename> <assumption_id> --id <new_id>

deepcell reasoning supersede-assumption model.deepcell a_hiring --id a_hiring_v2 --label 'Hiring lands one quarter late'

Argument	Type	Required
filename	text	required
assumption_id	text	required

Flag	Type	Default	What it does
--id <new_id>	text	required	Id of the replacement Assumption.
--label <label>	text	—	<Label> text of the replacement. The finding itself, not the subject it concerns — "Working capital is a source of cash", not "Working capital". Renders as the reasoning outline row, and a Deck may bind it as a slide headline.
--label-file <label_file>	file	—	File holding the replacement <Label> text; '-' reads stdin. Prefer this over --label for text containing '$' — inline shell arguments mangle dollar amounts.
--body <body>	text	—	<Body> text of the replacement.
--body-file <body_file>	file	—	File holding the replacement <Body> text; '-' reads stdin. Prefer this over --body for text containing '$' — inline shell arguments mangle dollar amounts.
--body-notation <body_notation>	markdown \| text	—	What the <Body> IS: markdown or literal text. Declared, never sniffed — no reader guesses from the bytes. Omitted leaves it as it was.
--item-refs <item_refs>	text	—	Comma-separated item ids.
--status-ref <status_ref>	text	—	Model Status dimension id.
--calc-ref <calc_ref>	text	—	CalcDef id this assumption drives.
--confidence <confidence>	float	—	Confidence in the replacement, 0-1.
--status <status>	holding \| uncertain \| broken \| superseded	—	Lifecycle status of the replacement.
--verified-at <verified_at>	text	—	ISO date (YYYY-MM-DD) this assumption was last confirmed to still hold (@verifiedAt). Records WHEN it was checked; --status holding records that it stands.
--broken-at <broken_at>	text	—	ISO date (YYYY-MM-DD) this assumption was found no longer to hold (@brokenAt). Records WHEN it failed; --status broken records THAT it failed — set both when actuals contradict an assumption.
--context-refs <context_refs>	text	—	Comma-separated context (period) ids this node reasons across.
--scenario-ref <scenario_ref>	text	—	Scenario id this node is about, when it holds only in one world.
--custom-dimensions <custom_dimensions>	text	—	Custom dimension members as `dim:member;dim2:member2` — the fifth axis of the anchor (e.g. `region:emea`).
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.

Exit codes: 0 — completed · 1 — written-but-invalid

reasoning supersede-claim

Replace CLAIM_ID with a new Claim, keeping the old one as history.

deepcell reasoning supersede-claim <filename> <claim_id> --id <new_id>

deepcell reasoning supersede-claim model.deepcell t_gm --id t_gm_v2 --label 'Gross margin expands, slower' --body 'Mix shift lifts GM 120bps.' --confidence 0.55

Argument	Type	Required
filename	text	required
claim_id	text	required

Flag	Type	Default	What it does
--id <new_id>	text	required	Id of the replacement Claim.
--label <label>	text	—	<Label> text of the replacement. The finding itself, not the subject it concerns — "Working capital is a source of cash", not "Working capital". Renders as the reasoning outline row, and a Deck may bind it as a slide headline.
--label-file <label_file>	file	—	File holding the replacement <Label> text; '-' reads stdin. Prefer this over --label for text containing '$' — inline shell arguments mangle dollar amounts.
--body <body>	text	—	<Body> text of the replacement.
--body-file <body_file>	file	—	File holding the replacement <Body> text; '-' reads stdin. Prefer this over --body for text containing '$' — inline shell arguments mangle dollar amounts.
--body-notation <body_notation>	markdown \| text	—	What the <Body> IS: markdown or literal text. Declared, never sniffed — no reader guesses from the bytes. Omitted leaves it as it was.
--kind <kind>	thesis \| risk \| catalyst \| counter \| question \| market_consensus	—	Kind of the replacement (defaults to the superseded claim's kind).
--item-refs <item_refs>	text	—	Comma-separated item ids.
--context-refs <context_refs>	text	—	Comma-separated context ids.
--status-ref <status_ref>	text	—	Model Status dimension id.
--calc-ref <calc_ref>	text	—	CalcDef id this claim is anchored to.
--confidence <confidence>	float	—	Confidence in the replacement, 0-1.
--strength <strength>	low \| med \| high	—	How strongly the replacement is held, qualitatively. Not inherited from the superseded claim: a reassessment that reused the old strength would publish a judgement nobody made.
--scenario-ref <scenario_ref>	text	—	Scenario id this node is about, when it holds only in one world.
--custom-dimensions <custom_dimensions>	text	—	Custom dimension members as `dim:member;dim2:member2` — the fifth axis of the anchor (e.g. `region:emea`).
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.

Exit codes: 0 — completed · 1 — written-but-invalid

reasoning update-argument

Patch an <Argument> edge; only the attributes you pass are changed.

deepcell reasoning update-argument <filename> [argument_id]

deepcell reasoning update-argument model.deepcell arg_pricing --weight 0.6

Argument	Type	Required
filename	text	required
argument_id	text	optional

Flag	Type	Default	What it does
--from-id <from_id>	text	—	Address: the edge's @from.
--edge-rel <edge_rel>	supports \| refutes \| depends_on \| derives_from \| variant_of \| supersedes \| contradicts \| references \| answers	—	Address: the @rel the edge has now. --rel is what to change it to.
--to-id <to_id>	text	—	Address: the edge's @to.
--rel <rel>	supports \| refutes \| depends_on \| derives_from \| variant_of \| supersedes \| contradicts \| references \| answers	—	Reclassify the edge — see `deepcell reasoning add-argument --help`.
--weight <weight>	float	—	How much this edge carries, 0-1.
--body <body>	text	—	Replacement <Body> text.
--body-file <body_file>	file	—	File holding the replacement <Body> text; '-' reads stdin. Prefer this over --body for text containing '$' — inline shell arguments mangle dollar amounts.
--body-notation <body_notation>	markdown \| text	—	What the <Body> IS: markdown or literal text. Declared, never sniffed — no reader guesses from the bytes. Omitted leaves it as it was.
--status <status>	text	—	Argument lifecycle status (active / superseded / revoked).
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.

Exit codes: 0 — completed · 1 — written-but-invalid

reasoning update-assumption

Update attributes on an existing <Assumption> ASSUMPTION_ID.

deepcell reasoning update-assumption <filename> <assumption_id>

deepcell reasoning update-assumption model.deepcell a_hiring --status broken --broken-at 2026-07-31

Argument	Type	Required
filename	text	required
assumption_id	text	required

Flag	Type	Default	What it does
--label <label>	text	—	Replacement <Label> text. The finding itself, not the subject it concerns — "Working capital is a source of cash", not "Working capital". Renders as the reasoning outline row, and a Deck may bind it as a slide headline.
--label-file <label_file>	file	—	File holding the replacement <Label> text; '-' reads stdin. Prefer this over --label for text containing '$' — inline shell arguments mangle dollar amounts.
--body <body>	text	—	Replacement <Body> text.
--body-file <body_file>	file	—	File holding the replacement <Body> text; '-' reads stdin. Prefer this over --body for text containing '$' — inline shell arguments mangle dollar amounts.
--body-notation <body_notation>	markdown \| text	—	What the <Body> IS: markdown or literal text. Declared, never sniffed — no reader guesses from the bytes. Omitted leaves it as it was.
--status-ref <status_ref>	text	—	Model Status dimension id (e.g. actual / projected) — NOT the assumption's lifecycle state (that is --status).
--calc-ref <calc_ref>	text	—	CalcDef id anchoring this assumption to a formula in the model.
--item-refs <item_refs>	text	—	Comma-separated item ids the assumption constrains — the fix for unanchored_assumption when the file has Items.
--confidence <confidence>	float	—	How strongly you hold this assumption, 0-1.
--status <status>	holding \| uncertain \| broken \| superseded	—	Assumption lifecycle state: holding until something contradicts it, broken once actuals do, superseded when a newer assumption replaces it.
--verified-at <verified_at>	text	—	ISO date (YYYY-MM-DD) this assumption was last confirmed to still hold (@verifiedAt). Records WHEN it was checked; --status holding records that it stands.
--broken-at <broken_at>	text	—	ISO date (YYYY-MM-DD) this assumption was found no longer to hold (@brokenAt). Records WHEN it failed; --status broken records THAT it failed — set both when actuals contradict an assumption.
--context-refs <context_refs>	text	—	Comma-separated context (period) ids this node reasons across.
--scenario-ref <scenario_ref>	text	—	Scenario id this node is about, when it holds only in one world.
--custom-dimensions <custom_dimensions>	text	—	Custom dimension members as `dim:member;dim2:member2` — the fifth axis of the anchor (e.g. `region:emea`).
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.

Exit codes: 0 — completed · 1 — written-but-invalid

reasoning update-claim

Update attributes on an existing <Claim> CLAIM_ID in FILENAME.

deepcell reasoning update-claim <filename> <claim_id>

deepcell reasoning update-claim model.deepcell t_gm --status falsified

Argument	Type	Required
filename	text	required
claim_id	text	required

Flag	Type	Default	What it does
--kind <kind>	thesis \| risk \| catalyst \| counter \| question \| market_consensus	—	Reclassify the claim — see `deepcell reasoning add-claim --help` for what each kind means.
--label <label>	text	—	Replacement <Label> text. The finding itself, not the subject it concerns — "Working capital is a source of cash", not "Working capital". Renders as the reasoning outline row, and a Deck may bind it as a slide headline.
--label-file <label_file>	file	—	File holding the replacement <Label> text; '-' reads stdin. Prefer this over --label for text containing '$' — inline shell arguments mangle dollar amounts.
--body <body>	text	—	Replacement <Body> text.
--body-file <body_file>	file	—	File holding the replacement <Body> text; '-' reads stdin. Prefer this over --body for text containing '$' — inline shell arguments mangle dollar amounts.
--body-notation <body_notation>	markdown \| text	—	What the <Body> IS: markdown or literal text. Declared, never sniffed — no reader guesses from the bytes. Omitted leaves it as it was.
--status-ref <status_ref>	text	—	Model Status dimension id (e.g. actual / projected) — NOT the claim lifecycle state (that is --status).
--calc-ref <calc_ref>	text	—	CalcDef id anchoring this claim to a formula in the model.
--item-refs <item_refs>	text	—	Comma-separated item ids anchoring this claim to a Spreadsheet — the fix for unanchored_claim when the file has Items.
--probability <probability>	float	—	Likelihood, 0-1 (required for kind=risk / catalyst).
--severity <severity>	low \| med \| high	—	Qualitative impact (required for kind=risk).
--confidence <confidence>	float	—	How strongly you hold this claim, 0-1.
--strength <strength>	low \| med \| high	—	How strongly the claim is held, qualitatively. Independent of --confidence (the numeric form); a claim may carry both.
--parent-claim-ref <parent_claim_ref>	text	—	Claim id this one hangs under (hierarchy, not an Argument edge).
--attribution <attribution>	text	—	Who holds this view (required for kind=market_consensus).
--status <status>	draft \| active \| superseded \| falsified \| revoked	—	Claim lifecycle state — NOT the model's Status dimension (that is --status-ref).
--context-refs <context_refs>	text	—	Comma-separated context (period) ids this node reasons across.
--scenario-ref <scenario_ref>	text	—	Scenario id this node is about, when it holds only in one world.
--custom-dimensions <custom_dimensions>	text	—	Custom dimension members as `dim:member;dim2:member2` — the fifth axis of the anchor (e.g. `region:emea`).
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.

Exit codes: 0 — completed · 1 — written-but-invalid

reasoning update-evidence

Patch an <Evidence> node; only the attributes you pass are changed.

deepcell reasoning update-evidence <filename> <evidence_id>

deepcell reasoning update-evidence model.deepcell <evidence_id>

Argument	Type	Required
filename	text	required
evidence_id	text	required

Flag	Type	Default	What it does
--label <label>	text	—	Replacement <Label> text. The finding itself, not the subject it concerns — "Working capital is a source of cash", not "Working capital". Renders as the reasoning outline row, and a Deck may bind it as a slide headline.
--label-file <label_file>	file	—	File holding the replacement <Label> text; '-' reads stdin. Prefer this over --label for text containing '$' — inline shell arguments mangle dollar amounts.
--body <body>	text	—	Replacement <Body> text.
--body-file <body_file>	file	—	File holding the replacement <Body> text; '-' reads stdin. Prefer this over --body for text containing '$' — inline shell arguments mangle dollar amounts.
--source <source>	text	—	Replacement @source (where the evidence came from).
--url <url>	text	—	Replacement @url.
--as-of <as_of>	text	—	Replacement @asOf date (ISO).
--item-refs <item_refs>	text	—	Comma-separated item ids.
--context-refs <context_refs>	text	—	Comma-separated context ids.
--status-ref <status_ref>	text	—	Model Status dimension id (e.g. actual / projected) the evidence speaks to.
--scenario-ref <scenario_ref>	text	—	Scenario id this node is about, when it holds only in one world.
--custom-dimensions <custom_dimensions>	text	—	Custom dimension members as `dim:member;dim2:member2` — the fifth axis of the anchor (e.g. `region:emea`).
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.

Exit codes: 0 — completed · 1 — written-but-invalid

write

Create a file, or replace an existing one wholesale.

deepcell write <filename>

deepcell write model.deepcell --file ./model.deepcell

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--stdin	boolean	—	Read content from stdin.
--file <from_file>	path	—	Read content from a local file.
--content <from_content>	text	—	Pass file content inline (useful for MCP/programmatic access).
--content-base64 <from_b64>	text	—	Pass file content as a base64-encoded string.
--revision <revision>	text	—	Expected revision SHA for optimistic locking — the `Revision:` line `deepcell cat` prints on stderr. The write is refused with a conflict if FILENAME changed since (a change to a different file is not a conflict).
--share	boolean	—	Print a view-only share link for FILENAME as well. On by default when you are not signed in, where it is the only URL that opens in a browser; off by default when signed in, since the workbench link already works. An existing live link for the file is reused rather than duplicated.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.

Exit codes: 0 — completed · 1 — written-but-invalid

revise

change a premise and reassess what depends on it

changes diff

Show what one change did, semantically.

deepcell changes diff <base_revision> [head_revision]

deepcell changes diff <base_revision>

Argument	Type	Required
base_revision	revision	required
head_revision	revision	optional

Flag	Type	Default	What it does
--file <filename>	text	—	Filter diff by filename.

Exit codes: 0 — completed

changes list

List document changes, newest first.

deepcell changes list [filename_pos]

deepcell changes list

Argument	Type	Required
filename_pos	text	optional

Flag	Type	Default	What it does
--file <filename>	text	—	Filter by filename.
--limit <limit>	integer range	20	Number of changes to show (1-200).
--since <since_revision>	revision	—	Only changes that moved the branch forward from this revision.

Exit codes: 0 — completed

changes revert

Undo one change by committing its inverse onto the current tip.

deepcell changes revert <base_revision> <head_revision>

Argument	Type	Required
base_revision	revision	required
head_revision	revision	required

Flag	Type	Default	What it does
--yes	boolean	—	Skip confirmation prompt.

Exit codes: 0 — completed

commit

Commit changes staged on the server by something other than you.

deepcell commit

Flag	Type	Default	What it does
--message <message>	text	—	Commit message.

Exit codes: 0 — completed · 1 — written-but-invalid

diff

Show diff between two revisions (like git diff).

deepcell diff <revision_a> [revision_b]

deepcell diff <revision_a>

Argument	Type	Required
revision_a	text	required
revision_b	text	optional

Flag	Type	Default	What it does
--file <filename>	text	—	Filter diff by filename.

Exit codes: 0 — completed

log

Show version history for the workspace (like git log).

deepcell log [filename_pos]

deepcell log

Argument	Type	Required
filename_pos	text	optional

Flag	Type	Default	What it does
--file <filename>	text	—	Filter by filename.
--limit <limit>	integer	20	Number of entries to show.
--after <after_sha>	text	—	Pagination cursor: start AFTER this commit sha. Pass the last sha of the previous page to read the next one.

Exit codes: 0 — completed

replace

Replace raw XML text in a file — the last-resort editor.

deepcell replace <filename> [old_string] [new_string]

deepcell replace model.deepcell "<Old>text</Old>" "<New>text</New>"

Argument	Type	Required
filename	text	required
old_string	text	optional
new_string	text	optional

Flag	Type	Default	What it does
--replace-all	boolean	—	Replace every occurrence instead of requiring a unique match.
--batch <batch_file>	text	—	Replacement as a JSON object {"old_string": "...", "new_string": "..."} — a file path, '-' for stdin, or inline JSON. Use this for multiline XML.
--revision <revision>	text	—	Expected revision SHA for optimistic locking.
--workspace <workspace_slug>	text	—	Override active workspace.
--rationale <rationale>	text	—	Why this edit was made. Becomes the commit message body, so the history reads as the decision rather than the coordinates the diff already shows. `-m` and `--message` are aliases of `--rationale`.
--title <title>	text	—	Short commit subject (e.g. 'Q3 actuals update'). Combined with --rationale as 'title: rationale'. The mechanical summary the server would have written is kept as a Summary trailer either way.

Exit codes: 0 — completed · 1 — written-but-invalid

restore

Restore the workspace to a previous revision (like git checkout).

deepcell restore <revision>

Argument	Type	Required
revision	text	required

Flag	Type	Default	What it does
--file <filename>	text	—	Restore specific file only.
--yes	boolean	—	Skip confirmation prompt.

Exit codes: 0 — completed

rm

Delete a file from the workspace.

deepcell rm <filename>

deepcell rm model.deepcell

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--yes	boolean	—	Skip confirmation prompt.

Exit codes: 0 — completed

variant checkout

Check out a variant branch for local edits.

deepcell variant checkout [name]

deepcell variant checkout

Argument	Type	Required
name	text	optional

Flag	Type	Default	What it does
--main	boolean	—	Switch back to the main branch (clear active variant).

Exit codes: 0 — completed

variant create

Create a new variant branch.

deepcell variant create <name>

Argument	Type	Required
name	text	required

Exit codes: 0 — completed

variant diff

Show diff between a variant branch and main.

deepcell variant diff [name]

deepcell variant diff

Argument	Type	Required
name	text	optional

Flag	Type	Default	What it does
--file <file_path>	text	—	Limit the diff to a single file.

Exit codes: 0 — completed

variant list

List variants in the workspace.

deepcell variant list

Exit codes: 0 — completed

variant merge

Merge a variant branch back into main.

deepcell variant merge [name]

deepcell variant merge

Argument	Type	Required
name	text	optional

Flag	Type	Default	What it does
--resolve <resolve>	ours \| theirs	—	Conflict resolution strategy: 'ours' keeps main, 'theirs' keeps variant.

Exit codes: 0 — completed · 1 — conflict

verify

change one thing, see everything it affects

assumption impact

List Claims that depend_on ASSUMPTION_ID.

deepcell assumption impact <filename> <assumption_id>

deepcell assumption impact model.deepcell a_hiring

Argument	Type	Required
filename	text	required
assumption_id	text	required

Exit codes: 0 — completed · 2 — unparseable-document

claim falsified

List every Claim in FILENAME whose status is `falsified`.

deepcell claim falsified <filename>

deepcell claim falsified model.deepcell

Argument	Type	Required
filename	text	required

Exit codes: 0 — completed · 2 — unparseable-document

claim history

Walk the supersedes chain backwards from CLAIM_ID (newest first).

deepcell claim history <filename> <claim_id>

deepcell claim history model.deepcell <claim_id>

Argument	Type	Required
filename	text	required
claim_id	text	required

Exit codes: 0 — completed · 2 — unparseable-document

claim variant

Show your view of CLAIM_ID beside the consensus it is a variant of.

deepcell claim variant <filename> <claim_id>

deepcell claim variant model.deepcell <claim_id>

Argument	Type	Required
filename	text	required
claim_id	text	required

Exit codes: 0 — completed · 2 — unparseable-document

impact apply

Apply one reviewed fix, and record it as `revised`.

deepcell impact apply <filename> <item_key> --surface <surface> --locator <locator> --op <op> --target-id <target_id>

deepcell impact apply model.deepcell <item_key> --surface <surface> --locator <locator> --op <op> --target-id <target_id>

Argument	Type	Required
filename	text	required
item_key	text	required

Flag	Type	Default	What it does
--surface <surface>	text	required	The surface the item is on.
--locator <locator>	text	required	The item's address.
--op <op>	text	required	The reasoning op to apply.
--target-id <target_id>	text	required	The Claim or Assumption it addresses.
--payload <payload>	text	—	The op's fields, as JSON. Omit for an op that needs none.
--new-claim <new_claim>	text	—	JSON for the replacement Claim. Required by supersede_claim.
--new-assumption <new_assumption>	text	—	JSON for the replacement Assumption. Required by supersede_assumption.
--expected-revision <expected_revision>	text	—	The revision you read at. A newer document is a 409 rather than an overwrite.

Exit codes: 0 — completed

impact reopen

Undo one review decision.

deepcell impact reopen <filename> <item_key>

deepcell impact reopen model.deepcell <item_key>

Argument	Type	Required
filename	text	required
item_key	text	required

Exit codes: 0 — completed

impact review

Mark one item reviewed — the marker disappears.

deepcell impact review <filename> <item_key> --surface <surface> --locator <locator>

deepcell impact review model.deepcell <item_key> --surface <surface> --locator <locator>

Argument	Type	Required
filename	text	required
item_key	text	required

Flag	Type	Default	What it does
--surface <surface>	text	required	The surface the item is on, as `impact show` prints it.
--locator <locator>	text	required	The item's address — the `locator` line `impact show` prints.
--outcome <outcome>	confirmed \| revised	confirmed	confirmed: it still reads correctly. revised: it was rewritten.
--kind <kind>	text	—	The item's kind. An unresolved one is refused: it needs a rebind.

Exit codes: 0 — completed

impact show

List every place that may need review after a change.

deepcell impact show <filename> --since <base_revision>

deepcell impact show model.deepcell --since <base_revision>

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--since <base_revision>	text	required	The revision to compare from: a SHA from `deepcell log`, or HEAD~N for the N-th commit before the workspace's newest (resolved through the log here; the server takes a 7-64 character SHA only). Note the SHA before you edit — a premise change is usually several commits, and HEAD~1 reaches only the last of them.
--revision <revision>	text	—	The revision to compare to (a SHA or HEAD~N). Defaults to the working tree.
--threshold <threshold>	float	—	Relative move at or above which a value change is material. Defaults to the built-in 1%.
--include-reviewed	boolean	—	Also show items somebody has already marked reviewed.

Exit codes: 0 — completed

reasoning-diff

Warn when an edit moved something a Claim was anchored to.

deepcell reasoning-diff <file>

deepcell reasoning-diff model.deepcell

Argument	Type	Required
file	path	required

Flag	Type	Default	What it does
--accept	boolean	—	Print warnings but exit 0 (acknowledge and continue).
--since-branch-base <since_branch_base>	path	—	Path to a third .deepcell file representing the branch base. When supplied, drift is computed across both branch_base->HEAD and HEAD->working intervals so accumulated commits surface.

Exit codes: 0 — completed · 1 — read-only-check · 2 — unparseable-document

relationships

Show the relationship graph of a .deepcell file.

deepcell relationships <filename>

deepcell relationships model.deepcell --type business

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--type <graph_type>	items \| dependencies \| blocks \| business \| unified	unified	Graph type. 'business' is the Item-centric Relationships workspace.

Exit codes: 0 — completed

present

deliver the work to someone else

Create a share link for FILENAME and print its viewer URL.

deepcell share create <filename>

deepcell share create model.deepcell --permission view

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--permission <permission>	view \| edit	view	Access level for the link. Edit links require an account.
--expires-days <expires_days>	integer range	—	Days until the link expires. Every link expires; omit this to take the server default (90 days, or 7 for a password-less --permission edit link). Larger values are clamped to that cap.
--expires-hours <expires_hours>	integer range	—	The same lifetime in hours, for a link that should outlive a meeting and not a day. Clamped against the same caps as --expires-days; pass one or the other, not both.
--password <password>	text	—	Password-protect the link (account required).
--label <label>	text	—	Label to recognize the link in `share list`.

Exit codes: 0 — completed

List active share links in the workspace.

deepcell share list

Flag	Type	Default	What it does
--file <filename>	text	—	Only links for this file.

Exit codes: 0 — completed

Revoke a share link by its id (see `share list`).

deepcell share revoke <share_id>

Argument	Type	Required
share_id	text	required

Exit codes: 0 — completed

to-docx

Export one document's prose as a Word file.

deepcell to-docx <filename>

deepcell to-docx model.deepcell --doc variance_note -o variance-note.docx

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--doc <doc_id>	text	—	Document ID (required when the file has multiple documents).
--scenario <scenario_id>	text	—	Document scenario ID to export.
--output <out_path>	text	—	Output path (default: <filename>.docx).
--bundle	boolean	—	Link to sibling .xlsx / .pptx exports written alongside this one.

Exit codes: 0 — completed

to-excel

Export a .deepcell file to Excel format.

deepcell to-excel <filename>

deepcell to-excel model.deepcell -o model.xlsx

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--output <out_path>	text	—	Output file path (default: <filename>.xlsx).
--formulas	boolean	—	Export with live Excel formulas.
--recalculate	boolean	—	Recompute formula values via the LibreOffice service (requires --formulas).
--scenario <scenario_id>	text	—	Document scenario ID to export (applies its VariableOverrides; omit for the default scenario).
--variant <variant_id>	text	—	(removed) Never worked — see --scenario for document scenarios.

Exit codes: 0 — completed

to-pdf

Export a deck or a document as a PDF.

deepcell to-pdf <filename>

deepcell to-pdf model.deepcell

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--from <source>	deck \| doc	deck	Which surface to render: the presentation deck, or the prose document.
--deck <deck_id>	text	—	Deck ID (required when the file has multiple decks).
--doc <doc_id>	text	—	Document ID (required when the file has multiple documents).
--scenario <scenario_id>	text	—	Document scenario ID to export.
--output <out_path>	text	—	Output path (default: <filename>_<deck\|doc>.pdf).

Exit codes: 0 — completed

to-pptx

Export one document-defined HTML deck as editable PowerPoint objects.

deepcell to-pptx <filename>

deepcell to-pptx model.deepcell --deck board -o board.pptx

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--deck <deck_id>	text	—	Deck ID (required when the document has multiple decks).
--scenario <scenario_id>	text	—	Document scenario ID to export.
--output <out_path>	text	—	Output path (default: <filename>.pptx).

Exit codes: 0 — completed

viewer

Print the browser URL to open FILENAME in the web workbench.

deepcell viewer <filename>

deepcell viewer model.deepcell

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--workspace <workspace_slug>	text	—	Override active workspace.
--open	boolean	—	Open the URL in the default browser.

Exit codes: 0 — completed

session

who you are and where your work lands

account delete

Permanently delete your account and everything it owns.

deepcell account delete

Flag	Type	Default	What it does
--confirm-email <confirm_email>	text	—	Your account email. Prompted for if omitted.
--password <password>	text	—	Account password. Prompted for if the account has one.
--yes	boolean	—	Skip the interactive 'this is irreversible' confirmation.

Exit codes: 0 — completed

account export

Download every record DeepCell holds about your account.

deepcell account export

Flag	Type	Default	What it does
--output <out_path>	file	—	Write the export to this file instead of stdout.

Exit codes: 0 — completed

doctor

Check this machine's setup: version, server, identity, workspace.

deepcell doctor

deepcell doctor -f json

Flag	Type	Default	What it does
--timeout <timeout>	float	10	How long to wait for the server probe.

Exit codes: 0 — completed

Authenticate with the DeepCell API.

deepcell login

Flag	Type	Default	What it does
--email <email>	text	—	Email for direct login (headless/CI).
--password <password>	text	—	Password for direct login (headless/CI).

Exit codes: 0 — completed

logout

Log out and remove stored credentials.

deepcell logout

Exit codes: 0 — completed

project create

Create a new project.

deepcell project create <name>

Argument	Type	Required
name	text	required

Flag	Type	Default	What it does
--slug <slug>	text	—	URL-friendly slug. Derived from the name by the server, with a short random suffix, if omitted — slugs are unique across all projects.
--description <description>	text	""	Project description.

Exit codes: 0 — completed

project info

Show project details.

deepcell project info [slug]

deepcell project info

Argument	Type	Required
slug	text	optional

Exit codes: 0 — completed

project list

List projects you belong to.

deepcell project list

Exit codes: 0 — completed

project use

Set the active project for subsequent commands.

deepcell project use <slug>

deepcell project use my-project

Argument	Type	Required
slug	text	required

Exit codes: 0 — completed

register

Create a new DeepCell account (headless/CI).

deepcell register

Flag	Type	Default	What it does
--email <email>	text	—	Account email.
--password <password>	text	—	Account password (min 8 chars).
--name <display_name>	text	—	Your display name.
--locale <locale>	text	zh-CN	Locale (default: zh-CN).

Exit codes: 0 — completed

upgrade

Check whether a newer deepcell CLI has been published.

deepcell upgrade

Exit codes: 0 — completed

upgrade check

Ask the package index right now and update the cached answer.

deepcell upgrade check

Flag	Type	Default	What it does
--timeout <timeout>	float	3	How long to wait for each package index.

Exit codes: 0 — completed

upgrade disable

Turn the automatic upgrade check off.

deepcell upgrade disable

Exit codes: 0 — completed

upgrade enable

Turn the automatic upgrade check on (the default).

deepcell upgrade enable

Exit codes: 0 — completed

upgrade status

Show the setting and the last cached answer.

deepcell upgrade status

Exit codes: 0 — completed

verify-email

Verify your email address.

deepcell verify-email

Exit codes: 0 — completed

whoami

Show the currently authenticated user.

deepcell whoami

Exit codes: 0 — completed

sync

local <-> cloud

clone

Clone a workspace to a local folder.

deepcell clone <slug> [directory]

deepcell clone <slug>

Argument	Type	Required
slug	text	required
directory	text	optional

Exit codes: 0 — completed

download

Download a file from the workspace to the local filesystem.

deepcell download <filename>

deepcell download model.deepcell

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--output <out_path>	text	—	Output file path (default: same as filename).
--revision <revision>	text	—	Download file at specific revision.

Exit codes: 0 — completed

merge apply

Apply conflict resolutions to a pending merge session.

deepcell merge apply <session_id> --resolve <strategy>

Argument	Type	Required
session_id	text	required

Flag	Type	Default	What it does
--resolve <strategy>	ours \| theirs	required	Resolution strategy for all conflicts.
--file <filename>	text	—	Write merged result to this local file.

Exit codes: 0 — completed · 1 — conflict

merge preview

Preview a three-way merge for a .deepcell file.

deepcell merge preview <filename>

deepcell merge preview model.deepcell

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--base <base_rev>	text	—	Base revision SHA (defaults to last_sync_sha).
--theirs-rev <theirs_rev>	text	—	Revision for theirs (defaults to HEAD).

Exit codes: 0 — completed · 1 — conflict

merge resolve

Resolve a sync conflict for a .deepcell file.

deepcell merge resolve <filename>

deepcell merge resolve model.deepcell

Argument	Type	Required
filename	text	required

Flag	Type	Default	What it does
--ours	text	—	Resolve all conflicts with local values.
--theirs	text	—	Resolve all conflicts with remote values.

Exit codes: 0 — completed · 1 — conflict

pull

Fetch latest cloud changes to the local folder.

deepcell pull

Exit codes: 0 — completed · 1 — conflict

push

Upload local changes to the cloud workspace.

deepcell push

Flag	Type	Default	What it does
--message <message>	text	""	Commit message for the push.

Exit codes: 0 — completed · 1 — written-but-invalid

status

Show local changes vs last sync.

deepcell status

Exit codes: 0 — completed

learn

the five reference surfaces

example

Complete, valid documents to copy the shape from.

deepcell example

Flag	Type	Default	What it does
--pack <pack>	text	—	Core examples plus this pack's.

Exit codes: 0 — completed

example get

Write an example document to a local file.

deepcell example get <name> --into <into>

Argument	Type	Required
name	text	required

Flag	Type	Default	What it does
--into <into>	file	required	Local path to write the document to.
--layer <layer>	skeleton \| full	full	Which document to seed from.
--force	boolean	—	Overwrite an existing file.

Exit codes: 0 — completed

example list

List every example name — the same output as bare `deepcell example`.

deepcell example list

Flag	Type	Default	What it does
--pack <pack>	text	—	Core examples plus this pack's.

Exit codes: 0 — completed

example show

Print one layer of an example: skeleton, full, or transcript.

deepcell example show [name] [layer]

deepcell example show

Argument	Type	Required
name	text	optional
layer	text	optional

Exit codes: 0 — completed

guide

Explain how DeepCell itself works.

deepcell guide [topic]

deepcell guide orient/start

Argument	Type	Required
topic	text	optional

Flag	Type	Default	What it does
--stage <stage>	text	—	Only this stage's topics (e.g. generate).
--pack <pack>	text	—	One domain pack: its vocabulary page, then its topics (e.g. finance).
--packs	boolean	—	List the domain packs.
--capabilities	boolean	—	Show the Jingwei/CLI/reference/transport capability contract.
--all	boolean	—	Also show the long-form reference pages and domain packs.
--search <search>	text	—	Topics whose name or description matches, across both catalogs.

Exit codes: 0 — completed

help

Every command, flag, exit code and example as one document.

deepcell help [command...]

deepcell help

Argument	Type	Required
command...	text	optional

Flag	Type	Default	What it does
--stage <stage>	text	—	Only this stage's commands (e.g. generate). Same stages as `deepcell guide`.
--search <search>	text	—	Commands whose name or summary matches TEXT.

Exit codes: 0 — completed

ref

Look up legal values, and resolve any typed id.

deepcell ref [target...]

deepcell ref lint/hardcoded_literal_in_calc

Argument	Type	Required
target...	text	optional

Flag	Type	Default	What it does
--limit <limit>	integer	40	Maximum search results.

Exit codes: 0 — completed

rules

The invariants applicable to a .deepcell work shape.

deepcell rules [rule_id]

deepcell rules R2

Argument	Type	Required
rule_id	text	optional

Flag	Type	Default	What it does
--pack <pack>	text	—	Add this domain pack's rules when their selected surface applies.
--surfaces <surfaces>	text	—	Comma-separated selected surfaces: reasoning,spreadsheet,document,deck. Omit for universal rules only.
--all	boolean	—	Every rule, whatever work shape it applies to. Overrides --surfaces/--pack.
--full	boolean	—	Print every applicable rule in full, not just the index — one call, no per-rule round trips.

Exit codes: 0 — completed

The rules

The invariants every model must satisfy, each with a stable id that other surfaces cite. Where a rule has lint backing, the listed code is what prints when the rule is broken — which is what turns it from advice into something you can check. The rest are audited in review.

deepcell rules R2

Rule	What it says	Enforced by	Lint code
rule:R1	Native generation — Excel at the edges only	review	—
rule:R2	Driver-based forecasts	lint	hardcoded_literal_in_calc
rule:R3	One file per request, edited in place	review	—
rule:R4	Forecasts must populate — verify by query-back	review	—
rule:R5	Self-checking calculations	review	—
rule:R6	Point-in-time results stay in their period	review	—
rule:R7	Canonical naming and units	lint	monetary_units
rule:R8	Reasoning stays connected to the work it explains	lint	unanchored_claim, unanchored_assumption, exclusivity_assertion, body_itemrefs_mismatch
rule:R9	Spreadsheet values have an intentional presentation	lint	unrendered_value
rule:R10	A DCF carries a real FCF bridge	review	—
rule:R11	Circular structures by deliberate convention — and seeded	review	—
rule:R12	Assumptions are grounded	lint	unsourced_actual, source_unused
rule:R13	Statuses and periods declare what they mean	lint	undeclared_status_archetype, undeclared_context_state
rule:R14	Analytical reasoning states its conclusion	lint	missing_apex_recommendation, dangling_conclusion_ref
rule:R15	Prose that asserts a value must link it	lint	uncited_level
rule:R16	An outward address lives in exactly one place	review	—
rule:R17	A cross-surface reference is a deepcell: URI	review	—
rule:R18	Overriding a calculated cell removes its formula	review	—
rule:R19	Analytical reasoning states the question it answers	lint	dangling_key_question_ref, ambiguous_key_question, key_question_not_answered, answers_non_question, unreviewed_key_question

Examples

Complete, valid documents to start from, each chosen for the mechanic it demonstrates rather than its industry. They are rebuilt from their own transcripts and linted in CI, so none of them is a stale snippet. Copy the line under one to seed a file with it.

Example	The mechanic it shows	Domain
decision/vendor-diligence	qualitative evidence-to-decision graph with a linked memo and no grid	procurement / security diligence
finance/cn-a-share-3s-dcf	extraction-based raw/model layering with filing provenance	A-share equity research
finance/ic-deck	a styled multi-slide deck bound onto a finished model, then exported	investment committee readout
finance/saas-dcf	the full three-statement + DCF loop	finance
ingest/board-pack	faithful workbook import — row/column mapping, converted formulas, per-cell provenance	public transport, board reporting
manufacturing/line-debottleneck	an author-drawn SVG exhibit whose geometry carries the argument	industrial manufacturing, plant throughput
ops/headcount-plan	items × contexts, drivers, and scenarios	HR / operations
product/launch-decision	small all-four-surface premise change with selective reassessment	product launch governance
project/build-budget	status axis (committed / actual / forecast) and variance self-checks	construction, grants
research/experiment-results	custom dimensions, actual vs expected status, and a <Document> write-up	science / experimental research
supply/inventory-plan	sensitivity blocks	logistics

decision/vendor-diligence

A complete decision can be qualitative: source-backed Evidence and explicit Assumptions connect to a declared conclusion, while the memo links those live nodes instead of inventing Items, Contexts, Values, a Sheet, or a Block.

deepcell example get decision/vendor-diligence --into <into>

An A-share issuer's three consolidated CAS statements pulled from cninfo with `deepcell ingest cn` and stored as an immutable raw layer — 元, full precision, bilingual labels, one <Source kind="filing"> whose <Cites at="page:N"> deep-link each statement — with historical mapping calcs onto the CAS chart's `_Model` ids, six mapping checks that read 0 on both filed years, and a P&L + DCF projection (the model-scopes default) on top.

deepcell example get finance/cn-a-share-3s-dcf --into <into>

finance/ic-deck

The model is done and the audience is a committee. Starting from the finished Lumenwave DCF, the transcript records the recommendation as a Claim first, then adds one deck, applies the consulting style pack verbatim, and writes seven slides whose every number, chart, sentence of reasoning and footnote is a binding against the model's real ids — value, series, chart, reasoning, source and document_stat — before reading `describe --lint` for the deck codes, exporting the .pptx and handing a reviewer a share link.

deepcell example get finance/ic-deck --into <into>

finance/saas-dcf

A linked income statement, balance sheet and cash flow statement feeding an unlevered DCF whose every forecast number traces to a driver item — with the three self-checks (BS_Check, CF_Recon, EV_Check) that prove the loop closed.

deepcell example get finance/saas-dcf --into <into>

ingest/board-pack

One `deepcell import` turns a board pack into the file — statuses with an archetype, contexts with a state, scale and currency on every monetary row, the pack's own formulas as live calcs, and one workbook Source citing the cell each number came from — and the work is what comes before it (reading the sheet into two JSON payloads) and after it (the round trip, verified before anything is built on top). Nothing is projected: three closed months and their quarter go in, and the same come out.

deepcell example get ingest/board-pack --into <into>

manufacturing/line-debottleneck

The measured line is already in the file and the numbers are not in dispute; what a table of five station cycle times cannot say is that the leak test's rejects re-enter the line upstream, at the weld cell. So the exhibit is a drawing. The transcript records the judgement as a Claim first, adds one deck, applies the product pack verbatim plus the ten classes the drawing needs, and writes an inline `<svg>` on the shape subset — `<defs><marker>` arrowheads reached by a local `url(#id)` fragment, colour and weight taken from the pack's own tokens so a restyle carries the drawing with it. Every figure stays outside the drawing and bound, because a `<dc-value>` inside an `<svg>` resolves to an HTML span that an SVG paints as nothing at all.

deepcell example get manufacturing/line-debottleneck --into <into>

ops/headcount-plan

Two hiring plans out of one model — every derived number traces to an editable driver row, and the second scenario is the handful of cells that differ rather than a second copy of the file. A check row rolls the whole group forward by a second route and reads 0 under both scenarios, and a <Document> summary quotes the same Q4 cells twice — once per scenario, by the `@scenario` tail of the cell locator.

deepcell example get ops/headcount-plan --into <into>

product/launch-decision

One calculation supports a declared launch decision, a memo, and a one-slide deck. The transcript starts from the before-state, changes one demand premise, discovers impact and backlinks, preserves the conclusion after checking its boundary, reconnects the replacement assumption, and verifies every selected surface.

deepcell example get product/launch-decision --into <into>

project/build-budget

Three readings of the same cell live on the Status dimension — not in three parallel item trees — a calc reaches across them with `Item[ctx]#status`, and every allocation and variance carries a cross-check whose correct answer is known to be 0.

deepcell example get project/build-budget --into <into>

research/experiment-results

A third axis and a second reading on the same row — the phenotype class is a custom Dimension that slices every data row instead of doubling it, and observed sits beside predicted under one item id rather than under two. The data is Mendel's published F2 counts for his seven traits, so the file has to carry a real result and a real objection to it at once: the counts fit 3:1, and CHIDIST says they fit it more closely than sampling error alone explains. The readout itself ships as a <Document>: every number in the prose is a link, so re-running the counts refreshes the values and identifies prose whose surrounding judgment must be reassessed explicitly.

deepcell example get research/experiment-results --into <into>

supply/inventory-plan

Sensitivity is a native `blockType="sensitivity"` block whose every cell is a transient recompute of the model — never a ladder of near-duplicate perturbation items — shown in all three legal shapes: 2-variable grid, 1-variable table, and scenario comparison.

deepcell example get supply/inventory-plan --into <into>

Setting up an agent that has never seen DeepCell? Open the agent quick start