@typescape-ai/cli 1.9.25 → 1.9.30

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.
Files changed (3) hide show
  1. package/README.md +72 -53
  2. package/dist/cli.js +691 -481
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -55,23 +55,38 @@ when you need the raw prompt-friendly text only.
55
55
  typescape review create --file docs/README.md --reviewer alice@example.com
56
56
  ```
57
57
 
58
- 5. Check draft content against those rules before submission:
58
+ 5. Optionally request a fast advisory pass:
59
59
 
60
60
  ```bash
61
61
  typescape rules check --file docs/README.md --properties '{"doc_type":"procedure"}'
62
62
  ```
63
63
 
64
- `rules check` exit codes are policy-aware: `0` means the check ran with no
65
- blocking findings, `1` means the check ran and found blocking findings, `2`
66
- is validation, `3` is network/auth, and `4` is a server error.
64
+ `rules check` is advisory. The canonical loop is:
67
65
 
68
- 6. Export feedback:
66
+ 1. `typescape rules get`
67
+ 2. the agent reads the draft and reasons over it
68
+ 3. `typescape finding create`
69
+
70
+ Its exit codes are still useful for automation: `0` means the advisory pass ran
71
+ with no blocking signals, `1` means it returned blocking signals, `2` is
72
+ validation, `3` is network/auth, and `4` is a server error.
73
+
74
+ 6. Record findings in plain language:
75
+
76
+ ```bash
77
+ typescape finding create --review sess_abc123 --body "Never mention supplements in patient-facing copy."
78
+ ```
79
+
80
+ 7. Export feedback:
69
81
 
70
82
  ```bash
71
83
  typescape review export --review rev_xxx
72
84
  ```
73
85
 
74
- `review export` defaults to the canonical `export.v2` contract. Pass `--schema v1` only for compatibility-only consumers that have not migrated yet.
86
+ `review export` defaults to the canonical `export.v2` contract. Explicit
87
+ `--schema v1` runtime requests are retired; use versioned views like
88
+ `response_matrix.v1` only when you intentionally need that bounded
89
+ compatibility shape.
75
90
 
76
91
  ## Commands
77
92
 
@@ -89,28 +104,28 @@ typescape review export --review rev_xxx
89
104
 
90
105
  ### Findings & Comments
91
106
 
92
- | Command | Description |
93
- | ------------------ | ----------------------------------- |
94
- | `finding create` | Create a new finding on a block |
95
- | `finding comment` | Post a reply to an existing finding |
96
- | `finding list` | List findings for a review |
97
- | `finding resolve` | Resolve a finding |
98
- | `finding decision` | Record a decision on a finding |
99
- | `finding evidence` | Attach evidence to a finding |
107
+ | Command | Description |
108
+ | ------------------ | ---------------------------------------------------- |
109
+ | `finding create` | Record a plain-language finding on a review or block |
110
+ | `finding comment` | Post a reply to an existing finding |
111
+ | `finding list` | List findings for a review |
112
+ | `finding resolve` | Resolve a finding |
113
+ | `finding decision` | Record a decision on a finding |
114
+ | `finding evidence` | Attach evidence to a finding |
100
115
 
101
116
  ### Rules
102
117
 
103
- | Command | Description |
104
- | ----------------- | -------------------------------------------- |
105
- | `rules list` | List active rules |
106
- | `rules get` | Get the canonical compiled rules bundle |
107
- | `rules check` | Check draft content against applicable rules |
108
- | `rules import` | Import markdown into a draft rule review |
109
- | `rules pack` | Compatibility alias for `rules get` |
110
- | `rules propose` | Create a rule proposal |
111
- | `rules proposals` | List rule proposals |
112
- | `rules decide` | Accept, reject, or deprecate a rule proposal |
113
- | `coverage` | Check section coverage against active rules |
118
+ | Command | Description |
119
+ | ----------------- | ----------------------------------------------------------- |
120
+ | `rules list` | List active rules |
121
+ | `rules get` | Get the canonical compiled rules bundle for agent reasoning |
122
+ | `rules check` | Request an optional server-side advisory pass |
123
+ | `rules import` | Import markdown into a draft rule review |
124
+ | `rules publish` | Publish a draft rule review |
125
+ | `rules revise` | Revise a rule review into a successor version |
126
+ | `rules deprecate` | Deprecate a published rule review |
127
+ | `rules pack` | Compatibility alias for `rules get` |
128
+ | `coverage` | Check section coverage against active rules |
114
129
 
115
130
  ### Review & Approval
116
131
 
@@ -130,33 +145,33 @@ typescape review export --review rev_xxx
130
145
 
131
146
  ### Orchestration & Collections
132
147
 
133
- | Command | Description |
134
- | ------------------- | ------------------------------------------------------ |
135
- | `repo list` | List connected repositories |
136
- | `repo connect` | Connect a repository by Git URL |
137
- | `repo branches` | List branches for a connected repository |
138
- | `project create` | Create a new upload-backed project |
139
- | `project list` | List projects |
140
- | `project get` | Get project detail |
141
- | `project update` | Update project metadata |
142
- | `project delete` | Start project deletion |
143
- | `project move` | Declare a project file-path move |
144
- | `project upload` | Upload files into a project batch |
145
- | `template create` | Create a reusable review template |
146
- | `template list` | List review templates |
147
- | `template get` | Get template detail |
148
- | `review-set create` | Create a multi-file review set |
149
- | `review-set list` | List review sets |
150
- | `review-set get` | Get review set overview |
151
- | `review-set update` | Update review set title or lifecycle state |
152
- | `review-set export` | Export a review set using compatibility-only schema=v1 |
153
- | `review-set status` | Evaluate aggregate review-set policy status |
154
- | `collection create` | Create a new collection |
155
- | `collection add` | Add reviews to a collection |
156
- | `collection get` | Get one collection with member reviews |
157
- | `collection list` | List collections |
158
- | `collection update` | Update collection metadata or archive state |
159
- | `collection delete` | Archive a collection via the canonical PATCH surface |
148
+ | Command | Description |
149
+ | ------------------- | ---------------------------------------------------- |
150
+ | `repo list` | List connected repositories |
151
+ | `repo connect` | Connect a repository by Git URL |
152
+ | `repo branches` | List branches for a connected repository |
153
+ | `project create` | Create a new upload-backed project |
154
+ | `project list` | List projects |
155
+ | `project get` | Get project detail |
156
+ | `project update` | Update project metadata |
157
+ | `project delete` | Start project deletion |
158
+ | `project move` | Declare a project file-path move |
159
+ | `project upload` | Upload files into a project batch |
160
+ | `template create` | Create a reusable review template |
161
+ | `template list` | List review templates |
162
+ | `template get` | Get template detail |
163
+ | `review-set create` | Create a multi-file review set |
164
+ | `review-set list` | List review sets |
165
+ | `review-set get` | Get review set overview |
166
+ | `review-set update` | Update review set title or lifecycle state |
167
+ | `review-set export` | Export a review set using canonical schema=v2 |
168
+ | `review-set status` | Evaluate aggregate review-set policy status |
169
+ | `collection create` | Create a new collection |
170
+ | `collection add` | Add reviews to a collection |
171
+ | `collection get` | Get one collection with member reviews |
172
+ | `collection list` | List collections |
173
+ | `collection update` | Update collection metadata or archive state |
174
+ | `collection delete` | Archive a collection via the canonical PATCH surface |
160
175
 
161
176
  ### Auth & Configuration
162
177
 
@@ -182,7 +197,11 @@ server:
182
197
 
183
198
  Set `TYPESCAPE_API_KEY` environment variable with your operator token.
184
199
 
185
- Legacy top-level `guidelines` and `gci` command families are compatibility history, not the canonical discovery surface. New automation should use the `rules` command family directly. Likewise, `export.v1` remains compatibility-only; first-party defaults use `export.v2`.
200
+ Legacy top-level `guidelines` and `gci` command families are compatibility
201
+ history, not the canonical discovery surface. New automation should use the
202
+ `rules` command family directly. Explicit `export.v1` runtime requests are
203
+ retired; first-party exports default to `export.v2`, while
204
+ `response_matrix.v1` remains a bounded compatibility view.
186
205
 
187
206
  ## License
188
207