@typescape-ai/cli 1.9.25 → 1.9.26
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 -24
- package/dist/cli.js +69 -53
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -55,17 +55,29 @@ 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.
|
|
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`
|
|
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
|
-
|
|
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
|
|
@@ -89,28 +101,28 @@ typescape review export --review rev_xxx
|
|
|
89
101
|
|
|
90
102
|
### Findings & Comments
|
|
91
103
|
|
|
92
|
-
| Command | Description
|
|
93
|
-
| ------------------ |
|
|
94
|
-
| `finding create` |
|
|
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
|
|
104
|
+
| Command | Description |
|
|
105
|
+
| ------------------ | ---------------------------------------------------- |
|
|
106
|
+
| `finding create` | Record a plain-language finding on a review or block |
|
|
107
|
+
| `finding comment` | Post a reply to an existing finding |
|
|
108
|
+
| `finding list` | List findings for a review |
|
|
109
|
+
| `finding resolve` | Resolve a finding |
|
|
110
|
+
| `finding decision` | Record a decision on a finding |
|
|
111
|
+
| `finding evidence` | Attach evidence to a finding |
|
|
100
112
|
|
|
101
113
|
### Rules
|
|
102
114
|
|
|
103
|
-
| Command | Description
|
|
104
|
-
| ----------------- |
|
|
105
|
-
| `rules list` | List active rules
|
|
106
|
-
| `rules get` | Get the canonical compiled rules bundle
|
|
107
|
-
| `rules check` |
|
|
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
|
|
115
|
+
| Command | Description |
|
|
116
|
+
| ----------------- | ----------------------------------------------------------- |
|
|
117
|
+
| `rules list` | List active rules |
|
|
118
|
+
| `rules get` | Get the canonical compiled rules bundle for agent reasoning |
|
|
119
|
+
| `rules check` | Request an optional server-side advisory pass |
|
|
120
|
+
| `rules import` | Import markdown into a draft rule review |
|
|
121
|
+
| `rules pack` | Compatibility alias for `rules get` |
|
|
122
|
+
| `rules propose` | Create a rule proposal |
|
|
123
|
+
| `rules proposals` | List rule proposals |
|
|
124
|
+
| `rules decide` | Accept, reject, or deprecate a rule proposal |
|
|
125
|
+
| `coverage` | Check section coverage against active rules |
|
|
114
126
|
|
|
115
127
|
### Review & Approval
|
|
116
128
|
|