deepcell-cli 0.6.1__py3-none-any.whl

deepcell_cli-0.6.1.dist-info/METADATA

@@ -0,0 +1,264 @@
+Metadata-Version: 2.4
+Name: deepcell-cli
+Version: 0.6.1
+Summary: Build and revise .deepcell documents from a terminal — the reasoning, the calculations, the document and the deck, with the links between them
+Author-email: DeepCell <hello@deepcell.net>
+License-Expression: MIT
+Project-URL: Homepage, https://deepcell.net
+Project-URL: Documentation, https://deepcell.net/product/cli
+Keywords: deepcell,cli,financial-modeling,business-intelligence
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Office/Business :: Financial
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: click>=8.1
+Requires-Dist: httpx>=0.28
+Requires-Dist: rich>=13.0
+Requires-Dist: mcp<2,>=1.26
+Requires-Dist: pyjwt>=2.8
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: respx>=0.22; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23; extra == "dev"
+Requires-Dist: jsonschema>=4.20; extra == "dev"
+
+# DeepCell CLI
+
+Command-line interface for **DeepCell** — a versionable `.deepcell` document that records the reasoning, the calculations, the document and the deck **together with the links between them**, so when an assumption changes you can see which conclusions still hold. AI agents read and write the format natively; this CLI is the primary tool for doing so from a terminal, script, or agent harness.
+
+```bash
+# macOS / Linux
+curl -LsSf https://beta.deepcell.net/install.sh | sh
+```
+
+```powershell
+# Windows (PowerShell)
+irm https://beta.deepcell.net/install.ps1 | iex
+```
+
+```bash
+deepcell --help
+deepcell-mcp --help           # MCP server (also included)
+```
+
+The installer picks uv or pip — whichever the machine has, fetching uv first if
+it has neither — finds where the console script actually landed, and adds that
+directory to your shell profiles so `deepcell` still resolves in the next
+shell. It handles the two cases a bare `pip install` does not: a stock Debian or
+Ubuntu image, which ships no pip, no `ensurepip` and no `venv` module, and a
+PEP 668 interpreter that refuses to install into itself. Running it twice is
+safe, and it verifies before reporting success.
+
+Prefer to install by hand? `deepcell-cli` is on PyPI:
+
+```bash
+uv tool install deepcell-cli
+uv tool update-shell
+```
+
+or `pip install deepcell-cli`.
+
+`deepcell: command not found` after installing by hand means the console script
+landed in a directory that is off `PATH` — not that the install failed. Re-run
+the installer above, which fixes exactly that; or use `python3 -m deepcell_cli`
+(`python -m` on Windows), which is the same CLI with no `PATH` involved.
+
+## Designed for agents
+
+The CLI is built to be driven programmatically:
+
+- **Machine-readable output.** Every command accepts `-f json` (also `table`, `plain`; default `plain`). Structured data goes to **stdout**, status/error messages to **stderr**, and failures exit non-zero — pipes and `jq` work cleanly:
+
+  ```bash
+  deepcell query model.deepcell Revenue FY2025E projected -f json | jq .value
+  ```
+
+- **Headless auth.** `deepcell register` creates an account without a browser; `DEEPCELL_ACCESS_TOKEN` injects a token for CI; `DEEPCELL_CONFIG` points at an alternate config file for session-scoped isolation.
+- **Non-interactive flags.** Destructive commands accept `-y`; `--project SLUG` targets a project per-invocation without mutating global state.
+- **Built-in workflow guidance.** `deepcell guide` lists the topics by workflow stage — `orient/start`, `generate/calcs`, `revise/scenarios`, `verify/lint`, `present/decks`, and the rest. Read one with `deepcell guide <topic>`, find one with `deepcell guide --search <text>`, and add the older flat topics with `deepcell guide --all`. When unsure how to model something, consult a guide topic before improvising.
+
+## Quick start
+
+```bash
+# 1. Authenticate — browser flow, or headless:
+deepcell login
+# deepcell register            # terminal-only account creation (CI/agents)
+
+# 2. Create and activate a project
+deepcell project create "My Project"
+deepcell project use my-project
+
+# 3. Work with files
+deepcell ls                                               # list files
+deepcell describe model.deepcell                          # inspect schema
+deepcell query model.deepcell Revenue FY2025E projected   # query one value
+deepcell query model.deepcell --sheet income_statement    # render a sheet
+deepcell edit model.deepcell Revenue_Growth FY2025E 0.12  # edit an assumption
+deepcell to-excel model.deepcell -o report.xlsx           # export to Excel
+```
+
+## Value addressing
+
+Every value is addressed by up to **five** dimensions:
+
+| Dimension | Role | Examples | If omitted |
+|-----------|------|----------|------------|
+| Item | what | `Revenue`, `COGS`, `WACC` | required |
+| Context | time period | `FY2025E`, `Q1_2024` | all contexts |
+| Status | actual vs. projected | `actual`, `projected` | all statuses |
+| Scenario (`--scenario`) | what-if branch | `bull`, `downside` | default scenario |
+| Custom dimensions (`--custom-dimensions`) | any extra axis | `geography:na;segment:cloud` | base cell |
+
+```bash
+deepcell query model.deepcell Revenue FY2025E projected
+deepcell query model.deepcell Revenue FY2025E --scenario bull
+deepcell query model.deepcell Revenue FY2025E --custom-dimensions "geography:na"
+deepcell cell-meta model.deepcell Revenue FY2025E    # formula, dependencies, provenance
+```
+
+The custom-dimension grammar is `dim:member`, semicolon-separated. Omitting a flag targets the **base cell**, never an error.
+
+## Editing: pick the right tool
+
+| You want to change… | Use | Why |
+|---------------------|-----|-----|
+| A hardcoded input (assumption, historical) | `deepcell edit FILE ITEM CTX VALUE` | literal Values |
+| A formula, item, period, scenario, sheet, format | `deepcell defs <op>` | structural, validated, atomic |
+| A computed cell → hardcoded override | `deepcell edit … --force` | flags the override explicitly |
+| A hardcoded cell → back to computed | `deepcell edit FILE ITEM CTX --clear` | lets the CalcDef re-govern it |
+| Raw XML (last resort) | `deepcell replace FILE OLD NEW` | string replacement with lint |
+
+Derived metrics belong in a **CalculationDefinition**, not hardcoded values — the engine recomputes every CalcDef on read (`deepcell guide generate/calcs`).
+
+```bash
+# Batch value edits (JSON array via file, inline, or stdin)
+deepcell edit model.deepcell --batch changes.json
+echo '[{"itemRef":"Revenue","contextRef":"FY2025E","newValue":"1500000","statusRef":"projected"}]' \
+  | deepcell edit model.deepcell --batch -
+
+# Structural edits
+deepcell defs add-item model.deepcell --name Gross_Profit --label "Gross Profit"
+deepcell defs add-calc model.deepcell --item Gross_Profit \
+  --formula "Revenue - COGS" --status projected --dry-run   # pre-flight, then re-run without --dry-run
+deepcell defs add-scenario model.deepcell --name Bull
+deepcell defs apply model.deepcell --ops ops.json     # many ops, atomically
+```
+
+`deepcell defs --help` lists the full op set: `add-* / update-* / delete-* / rename-* / reorder-*` for items, calcs, contexts/periods, scenarios, statuses, formats and rules, presentation blocks, and sensitivity tables, plus `header` for document metadata.
+
+## Command reference
+
+| Group | Commands |
+|-------|----------|
+| Auth | `login`, `register`, `logout`, `whoami`, `verify-email`, `account` |
+| Projects | `project list / use / create / info` |
+| Files | `ls`, `cat`, `write`, `rm`, `download` |
+| Inspection | `describe`, `query`, `cell-meta`, `relationships`, `grep`, `doctor` |
+| Editing | `edit`, `defs`, `replace`, `variant checkout / create / diff / merge / list` |
+| Document surface | `doc` — outline, blocks, body, links, lint |
+| Deck surface | `deck` — slides, ordering, binding, branding |
+| Change review | `changes list / diff / revert`, `impact` |
+| Version control | `log`, `diff`, `restore` |
+| Sync | `clone`, `status`, `pull`, `push`, `commit`, `merge` |
+| Import / export | `import`, `ingest`, `to-excel`, `to-docx`, `to-pptx`, `to-pdf` |
+| Reasoning | `reasoning`, `reasoning-diff`, `claim`, `assumption` |
+| Delivery | `viewer`, `share create / list / revoke` |
+| Knowledge | `help`, `guide`, `rules`, `ref`, `example` |
+
+Run `deepcell <command> --help` for detailed usage — the help text includes worked examples for every mode.
+
+## Reasoning
+
+`.deepcell` files carry a typed reasoning graph — **Claims**, **Assumptions**, **Evidence**, connected by **Argument** edges — so a model explains *why* its numbers are what they are:
+
+```bash
+deepcell reasoning add-claim model.deepcell --id rev-thesis --kind thesis \
+  --label "Revenue doubles by FY27" --item-refs Revenue
+deepcell reasoning graph model.deepcell        # render as Mermaid
+deepcell reasoning impact model.deepcell rev-thesis   # what depends on this claim?
+deepcell reasoning lint model.deepcell         # structural checks
+deepcell claim model.deepcell                  # inspect claims
+deepcell assumption model.deepcell             # inspect assumptions
+```
+
+See `deepcell guide revise/reasoning` and `deepcell guide verify/review`.
+
+## Variants, history, and merge
+
+```bash
+deepcell variant create "Best Case"       # parallel assumption set, no file copies
+deepcell variant checkout best-case
+deepcell variant diff best-case           # vs main
+deepcell variant merge best-case
+
+deepcell log                              # like git log
+deepcell diff abc123 def456               # compare two revisions
+deepcell restore abc123                   # like git checkout
+
+deepcell merge resolve model.deepcell     # semantic 3-way merge of sync conflicts
+deepcell merge resolve model.deepcell --ours   # keep local values (--theirs: remote)
+```
+
+## Sync (local ↔ cloud)
+
+```bash
+deepcell clone my-project              # download to ./my-project/
+cd my-project
+# ... edit files locally ...
+deepcell status                          # A/M/D vs last sync
+deepcell push -m "Updated assumptions"   # upload
+deepcell pull                            # fetch cloud changes
+```
+
+A `.deepcell/` metadata directory tracks the project link and sync state. `push` refuses to clobber cloud changes — it asks you to `pull` first. See `deepcell guide revise/history`.
+
+## Import & export
+
+```bash
+deepcell import revenue.xlsx --items items.json --contexts contexts.json \
+  --aggregations aggregations.json --keep-raw
+deepcell to-excel model.deepcell -o report.xlsx --formulas   # live Excel formulas
+deepcell to-docx model.deepcell -o memo.docx                 # the document, as Word
+deepcell to-pptx model.deepcell -o deck.pptx                 # HTML deck → editable PowerPoint
+deepcell to-pdf model.deepcell -o memo.pdf                   # the document, as PDF
+deepcell ingest cn ...                                        # A-share (cninfo) filings
+```
+
+`--aggregations` maps and combines source rows into target coordinates (`SUM`, `AVERAGE`, `MIN`, `MAX`, `COUNT`); `--keep-raw` retains originals alongside. See `deepcell guide excel-import` and `deepcell guide schema-matching`.
+
+## MCP server
+
+The package ships `deepcell-mcp`, exposing the whole CLI to MCP clients (Claude Code, Claude.ai, and others) as a single `deepcell(command)` tool:
+
+```bash
+deepcell-mcp                      # stdio transport (local)
+deepcell-mcp --http               # streamable-http on 127.0.0.1:8080
+```
+
+Interactive and sync commands (`login`, `clone`, `push`, …) are blocked inside MCP; authenticate with an API key or OAuth instead.
+
+## Environment variables
+
+| Variable | Purpose | Default |
+|----------|---------|---------|
+| `DEEPCELL_API_URL` | API endpoint | `https://beta.deepcell.net/api/jingwei` |
+| `DEEPCELL_PROJECT` | Override active project | _(none)_ |
+| `DEEPCELL_ACCESS_TOKEN` | Auth token for CI/headless use | _(none)_ |
+| `DEEPCELL_CONFIG` | Alternate `config.json` path (session-scoped) | `~/.deepcell/config.json` |
+| `DEEPCELL_NO_ANON` | Opt out of the anonymous first-use session | _(unset)_ |
+| `DEEPCELL_NO_UPGRADE_CHECK` | Silence the upgrade-available notice for this process | _(unset)_ |
+
+Precedence: per-invocation flags (`--project`) > environment > `~/.deepcell/config.json`. Credentials live in `~/.deepcell/credentials.json` (`0600`); token refresh is automatic.
+
+## License
+
+MIT. The CLI is developed in a private repository, so there is no public source
+link to follow from here — the licence is what ships in the package metadata.

deepcell_cli-0.6.1.dist-info/RECORD

@@ -0,0 +1,67 @@
+deepcell_cli/__init__.py,sha256=lrcFD_GeSK_UMiAExu0-eJaxNF0yLPpNp9w0NJUymMA,614
+deepcell_cli/__main__.py,sha256=twFeeBXG4q6cwE9_udVK9o7vJDFS19so4rWnmen2yS8,93
+deepcell_cli/_findings.py,sha256=uNFunU0ZG8ZyFE5OIUn6MyP5hEddpMqu2-jPYsc1mXc,3690
+deepcell_cli/capabilities.py,sha256=Zy_FlQCQfLKnH0mpiDqFTaAP4t2Cz-kkBCL0idK8JK0,28663
+deepcell_cli/capability-contract.json,sha256=5_G66Qc_I2IKjcH4j0thjFbPui9QKFkFGrSt8IeFyAY,377123
+deepcell_cli/client.py,sha256=eZwrC3wgXDm5Kqw804WsFfrnmnZF9BqCTaqIOeBDbOo,21499
+deepcell_cli/config.py,sha256=6wCOfYI8KkVjihvLoz-OMA-5CdHKx8zW0moUhs5aeQc,13243
+deepcell_cli/context.py,sha256=1v8ZOldUspWCarTi1lU8H_my_pw9SV1Oh2nI7B09v_I,7831
+deepcell_cli/errors.py,sha256=k7tmtcsn87tJHT_5WTLgV33aDEDghuG4kPq2e27lgIE,5012
+deepcell_cli/logging_setup.py,sha256=Yw5uWxEBIw13Wy9qUznyk6HCv2gofUg0uz2fUvDGSko,6455
+deepcell_cli/main.py,sha256=Gq3Lz6MWbeCk0lxhP0CwULoOkZoGSnXUPkvKEN0FcSQ,21884
+deepcell_cli/mcp_server.py,sha256=wr8Yo4Ce2Ytz94nPEabWNhdXWp56V-pTl1ys9w_eQxM,40062
+deepcell_cli/oauth_provider.py,sha256=1KxNm27K2izF_8sok9v9Fiu_XjHxN-RsWCPYX-_tjNs,24282
+deepcell_cli/output.py,sha256=IkLTyNf21EzcHFvYIEgOLwQbX0pW0ps3kniXuHCtF3o,19872
+deepcell_cli/revision.py,sha256=UNju-f_sQF7kbK3DNiU7e-G61RaY6F9e5ztyO0v_MoI,6620
+deepcell_cli/stages.py,sha256=F4yPFo-UC8a6xayhVzcRxHHabTIvlkcC1qIk6gqknrQ,8204
+deepcell_cli/surface.py,sha256=d7Aja8vFpOJnaCiCPYvZn8foRBsQbtJjQPzX9zlnfDo,30209
+deepcell_cli/sync_state.py,sha256=9xzI7MJssfoKHhzWjT0UDJfNexvQ78lgC-7dmGA9Zxs,4005
+deepcell_cli/upgrade_check.py,sha256=bk43dpWWvo6Kky-FKTGsi_ll4iIAd4-q8bmExcFO_AM,15864
+deepcell_cli/xml_replace.py,sha256=6rhoSap-LmBOiwNmOF35MuLMTpNEUFyajK3uk_P0Hik,2933
+deepcell_cli/commands/__init__.py,sha256=gQ6tnU0Rvm0-ESWFUBU-KDl5dpNOpUTG509hXOQQjwY,27
+deepcell_cli/commands/_batch_input.py,sha256=VCARzEcBX-VazBmY-RLiWQhaF1ei4tZZQaqnwOupbXU,919
+deepcell_cli/commands/_datatypes.py,sha256=l4EblrepzUSJNUaSCnqh3nNaTI3f3bI3w7DuhlOm7Y8,1979
+deepcell_cli/commands/_negative_args.py,sha256=76Va6hcAiBpXBc8Uzm4tGFBkY-6iwPBA3EBviNobR1s,5408
+deepcell_cli/commands/_swapped_args.py,sha256=QL1VDKlYPpoUcrGV9p-OtWDVwh-WNr8-Thdzsf2RIlA,6664
+deepcell_cli/commands/_version_display.py,sha256=9KXYlZW4FZ3iv1ENEk1ZzkHAU9alNQhn_Za4X2_XWpk,1333
+deepcell_cli/commands/_write_opts.py,sha256=8SeVZ8iovemSi9DRr58hg1WASPrCrBuqcfgogO9rwFQ,6564
+deepcell_cli/commands/account.py,sha256=T2yNFpfr7ZOz4xhWEb7OcT5JoWmVCKRUv1extR2bX8U,4143
+deepcell_cli/commands/auth.py,sha256=SrCT1xma_Bnrz9WCd_s_NVegkzI24YPHv1wTNYVXmM0,22653
+deepcell_cli/commands/changes.py,sha256=7Zg2t6b4OJTglRr1qrVLYIOlUE9GI7IxfdHWMw3R0EY,11063
+deepcell_cli/commands/deck.py,sha256=VO_HA1rGiiyeeAGzT9i-ZFIBuko8-GXDWQ9o078Byks,20507
+deepcell_cli/commands/defs.py,sha256=pckZ9TFT-OlGwDovc001gwNhTwmqHOQkesQ2w0zChwc,145371
+deepcell_cli/commands/describe.py,sha256=GKec_VNnJBwHmAzN0So6V-mDHiDaOMJqtKJ5PVGizKA,36391
+deepcell_cli/commands/doc.py,sha256=I9qav43HOFv5j7x1TBP_eGm-s3_dT5fOsMBlaPjKOic,23607
+deepcell_cli/commands/doctor.py,sha256=czOFStYQE_MN3irZgB9pd1H-HD8eXdh3dcOTaQff89o,10477
+deepcell_cli/commands/download.py,sha256=TcTLAJqRlgD7V5P4bGHKSOfbmFrg_3afxqfm9HuvYGw,1497
+deepcell_cli/commands/edit.py,sha256=5vKaveOYvxdpONdXDnGYc01hlzBa9Ap_UEOCuhU1Y6w,16267
+deepcell_cli/commands/example.py,sha256=4ti1T_Z2Wka-NiIGjn8F22hz7HmEog6DA4Z8zFgm8tM,6083
+deepcell_cli/commands/export.py,sha256=NJOkweSgmy75gqX7X6QqzB4lEokzSqM5FRPVaPk4TnA,3381
+deepcell_cli/commands/export_docx.py,sha256=II1tbjuE24KecFlP-J-xQD2JOtUdsUUv8yobsvCfJQ4,2186
+deepcell_cli/commands/export_pdf.py,sha256=VUT-VLqJLFXM2sLYwrb46fpdXo3N-Zlwm0M711U95tc,2596
+deepcell_cli/commands/export_pptx.py,sha256=etbBAeXTCpXBnut-NeaLlX6RX5rSFjfjzV65tTRKn1k,1664
+deepcell_cli/commands/files.py,sha256=u8HNyLyELsrVqegXYlqbh6umLj5iRIEiryzVdPBYYBs,15781
+deepcell_cli/commands/grep.py,sha256=vRREb3EK-jU03Ti-UwsOqfpMzrqzQJ4vFX1nYRsc2r4,3167
+deepcell_cli/commands/guide.py,sha256=jcRwUBcbY10JGuNYVBY6vhQlSv2qmwLESU_phhvhQYA,18231
+deepcell_cli/commands/help_cmd.py,sha256=If-K2_sgthLRN2Rb0IsOTQaQQQ-k05gJzmrQL2QBOCU,14121
+deepcell_cli/commands/impact.py,sha256=NknuEAqFI4lPQLtLRLXq2dOZqyUVO9DUUsrndo60UkA,15597
+deepcell_cli/commands/import_cmd.py,sha256=zREmfzzUHtaRvPHFqOn-xYeN9L5fq1iD2KyKn0nxARs,8863
+deepcell_cli/commands/ingest.py,sha256=pzE68lzbuRhrpHoC-CGXA_t1IM4i0MRGd1d-rK9ipTI,4228
+deepcell_cli/commands/merge.py,sha256=ADPHUjmDfl1YeQGtlg03V0sbaqMNsshiaLad9BclaAU,15431
+deepcell_cli/commands/query.py,sha256=abj4J-pohCmwZdIc19oNJXhxIOP_1tm6TKSnUW7Bg7o,30057
+deepcell_cli/commands/reasoning.py,sha256=zr-ARlCmrCB8Uf-YDKu9ph0ND743b-BCuIczWx-h0xo,111350
+deepcell_cli/commands/ref.py,sha256=4-XE1WyPfD_bU8RUftPZemyRBMXCOw_KsMvkJjrqY_Y,10926
+deepcell_cli/commands/replace.py,sha256=jPXpnvEd86M_ktNxxOXeTdoC3ZaRFq9605RK4NxZnYc,12618
+deepcell_cli/commands/rules.py,sha256=Yh8_NmlPFBroqUFfsV8Cahc2Ea6jOavYpBFlKWFm9_w,7813
+deepcell_cli/commands/share.py,sha256=4fYr_ESM1Eu048LOdvNAEun_drbICIHVMijLnJw_mHk,6776
+deepcell_cli/commands/sync.py,sha256=ejioNuLXxQd7GgfpkfbbXhmC4qHx6rRnMW5P0G_75S4,33364
+deepcell_cli/commands/upgrade.py,sha256=xQwHFWZ5Zdn-SZEE6-hZYuJzQpLCc12nFmXfj3HI0n4,6145
+deepcell_cli/commands/variant.py,sha256=nX-GgMwj_tRwnjLkIoXaqkWeamVlhljPWiOd3nSY5fc,14288
+deepcell_cli/commands/version.py,sha256=AZPJ2zZl4oSqdKar9U45UICzp3SMpwaFXcshErIWGzM,16721
+deepcell_cli/commands/viewer.py,sha256=89J-wb08R-M_REhnway8jMWhH2MDfEqx-aWAeL2G5qk,2292
+deepcell_cli/commands/workspace.py,sha256=EgLtBrbl52WOOrPD37dDLmR6lEIrHkwU7kN4bt6MLv0,3631
+deepcell_cli-0.6.1.dist-info/METADATA,sha256=a49_3eEUaHQmHhQKqGyqX0CHvaaOBDrJYukzKSGncjw,12809
+deepcell_cli-0.6.1.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+deepcell_cli-0.6.1.dist-info/entry_points.txt,sha256=L_Di-7uVO8u4bTMBqKi1bN9jqelTlYo8e5eGl2CmS2M,95
+deepcell_cli-0.6.1.dist-info/top_level.txt,sha256=IpXvBRR1hPFx3146MPNIBMPeyhU5aMoxVtMqiaXzGx0,13
+deepcell_cli-0.6.1.dist-info/RECORD,,

deepcell_cli-0.6.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

deepcell_cli-0.6.1.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+deepcell = deepcell_cli.main:cli
+deepcell-mcp = deepcell_cli.mcp_server:main

deepcell_cli-0.6.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+deepcell_cli