@uwmd/cli 2.6.2 → 2.8.0
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 +36 -3
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -9,13 +9,13 @@ This package is a thin wrapper around [`@uwmd/core`](https://www.npmjs.com/packa
|
|
|
9
9
|
No install needed — run via `npx`:
|
|
10
10
|
|
|
11
11
|
```bash
|
|
12
|
-
npx uwmd <command> [args]
|
|
12
|
+
npx @uwmd/cli <command> [args]
|
|
13
13
|
```
|
|
14
14
|
|
|
15
15
|
Or install globally:
|
|
16
16
|
|
|
17
17
|
```bash
|
|
18
|
-
npm install -g uwmd
|
|
18
|
+
npm install -g @uwmd/cli
|
|
19
19
|
uwmd <command> [args]
|
|
20
20
|
```
|
|
21
21
|
|
|
@@ -23,7 +23,7 @@ uwmd <command> [args]
|
|
|
23
23
|
|
|
24
24
|
| Command | What it does |
|
|
25
25
|
|---|---|
|
|
26
|
-
| `uwmd init <file>` | Scaffold a blank `.
|
|
26
|
+
| `uwmd init <file>` | Scaffold a blank `.uwx.md` deal file |
|
|
27
27
|
| `uwmd parse <file>` | Parse and emit canonical JSON |
|
|
28
28
|
| `uwmd validate <file>` | Run the full Tier-1 validator and print issues |
|
|
29
29
|
| `uwmd render <file>` | Render to `chat`, `summary`, or full markdown |
|
|
@@ -40,6 +40,27 @@ uwmd <command> [args]
|
|
|
40
40
|
|
|
41
41
|
Run any command without arguments for usage help.
|
|
42
42
|
|
|
43
|
+
## Calculation context files (source implementation)
|
|
44
|
+
|
|
45
|
+
The source checkout adds `--calc-context <JSON file>` to `calc` and `refine`.
|
|
46
|
+
This flag is included in the 2.8.0 release line. After building the
|
|
47
|
+
checkout, run from the repository root:
|
|
48
|
+
|
|
49
|
+
```sh
|
|
50
|
+
npm run cli -- calc deal.uwx.md "dcf.annual_cash_flows@Y3.noi" --calc-context context.json --json
|
|
51
|
+
npm run cli -- refine deal.uwx.md --targets year_three_noi_per_unit --calc-context context.json --json
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
`year_three_noi_per_unit` must be a calculation declared in the deal. A context
|
|
55
|
+
file can contain `{"sectionVariants":{"dcf":"base"},"overrides":{}}`.
|
|
56
|
+
Variants select period references only. Overrides use exact paths and JSON
|
|
57
|
+
scalars, preserving zero and null. `calc` supports ordinary and period overrides;
|
|
58
|
+
`refine` rejects ordinary scalar overrides and requires canonical period keys.
|
|
59
|
+
Inspect refinement's `diagnostics.period_inputs` for excluded outputs.
|
|
60
|
+
|
|
61
|
+
See the [complete source guide](../../docs/CALCULATION_CONTEXT.md)
|
|
62
|
+
for context validation, missing inputs, Excel export and library usage.
|
|
63
|
+
|
|
43
64
|
## Library use
|
|
44
65
|
|
|
45
66
|
If you're writing TypeScript / JavaScript and need programmatic access to the parser, validator, renderer, or calc engine, depend on [`@uwmd/core`](https://www.npmjs.com/package/@uwmd/core) directly:
|
|
@@ -59,3 +80,15 @@ This CLI is the reference implementation of the UW Markdown protocol's Tier-1 (R
|
|
|
59
80
|
## License
|
|
60
81
|
|
|
61
82
|
[MIT](https://github.com/UWMD-OSP/UW-Markdown/blob/main/LICENSE) © UW Markdown contributors.
|
|
83
|
+
|
|
84
|
+
### Project verified lease-up amounts (2.8.0)
|
|
85
|
+
|
|
86
|
+
```sh
|
|
87
|
+
uwmd project-lease-up deal.uwx.md cash-dates.json --json
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
The plan requires exact `source_variant`, explicit `day_count` and a complete
|
|
91
|
+
`cash_dates` array of `{ period, date }` mappings. Success emits a JSON candidate
|
|
92
|
+
with source digest and binding evidence. Refusals exit 1 and retain nested
|
|
93
|
+
diagnostics with `--json`. No input files are edited. This partial stream covers
|
|
94
|
+
rent receipts, concessions and TI/LC only; it is not a complete DCF.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@uwmd/cli",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.8.0",
|
|
4
4
|
"description": "Command-line installer for UW Markdown — `npx uwmd init|parse|validate|render|run` for .uw.md underwriting files. Thin wrapper over @uwmd/core.",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -22,7 +22,7 @@
|
|
|
22
22
|
"prepublishOnly": "npm --prefix ../uwmd-core run build && npm --prefix ../.. test && npm --prefix ../.. run conformance && npm --prefix ../.. run validate-schemas"
|
|
23
23
|
},
|
|
24
24
|
"dependencies": {
|
|
25
|
-
"@uwmd/core": "2.
|
|
25
|
+
"@uwmd/core": "2.8.0"
|
|
26
26
|
},
|
|
27
27
|
"devDependencies": {
|
|
28
28
|
"@types/node": "^20.0.0",
|