@scribed/cli 0.1.40 → 0.1.41

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -9,6 +9,33 @@ option audit are recorded in the maintainers' offline audit inventories, which
9
9
  are not part of this package (in the source tree, see
10
10
  `scripts/refine-route-changes.ts --routes/--coverage`).
11
11
 
12
+ ## Financial models and simulated 409A
13
+
14
+ The modeling tools read accounting actuals directly from your live QuickBooks or
15
+ Puzzle connection through Scribed API. Select an explicit workspace for your
16
+ company baseline and Scribed Capital cap table/investor context. Saved Financials
17
+ entries, imported history, Drive/Vault documents and general workspace knowledge
18
+ are not model sources. `financials_model_sources` returns live account metadata
19
+ and workspace company choices; `capitalCompanyId` selects a workspace company,
20
+ while `companyId` selects a Puzzle provider company.
21
+
22
+ Use `financials_model_prepare`, review the editable assumptions, then run
23
+ `financials_model_preview` or `financials_model_valuation`. Their `report.token`
24
+ is a private, short-lived reference to that exact result. Save it with the same
25
+ `workspaceId` in a local input JSON file, then download the PDF:
26
+
27
+ ```bash
28
+ scribed call financials_model_report --input report.json --out forecast.pdf
29
+ ```
30
+
31
+ `financials_model_report_to_vault` accepts that same token plus `confirmed: true`,
32
+ one stable UUID `requestId` and an optional `folder`. It saves the PDF privately
33
+ without repeating model calculation or AI; the returned `vault_download`
34
+ descriptor retrieves the saved bytes. Read-only MCP grants exclude this save.
35
+ `financials_model_export` still provides an optional formula XLSX. All model
36
+ tools are interactive only and keep the existing workspace/export permissions.
37
+ Simulated 409A results are not an independent appraisal or an option strike price.
38
+
12
39
  ## Install
13
40
 
14
41
  Requires Node.js 20 or newer; users do not need Bun.