@typescape-ai/cli 1.5.1 → 1.7.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 +63 -7
- package/dist/cli.js +358 -322
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,21 +1,27 @@
|
|
|
1
1
|
# @typescape-ai/cli
|
|
2
2
|
|
|
3
|
-
Typescape CLI
|
|
3
|
+
Typescape CLI — create review sessions, export feedback, manage threads, and integrate with AI workflows.
|
|
4
4
|
|
|
5
5
|
## Requirements
|
|
6
6
|
|
|
7
|
-
- [Bun](https://bun.sh/) >= 1.
|
|
7
|
+
- [Bun](https://bun.sh/) >= 1.3.8
|
|
8
|
+
|
|
9
|
+
Typescape CLI requires the Bun runtime. It will not work with Node.js.
|
|
8
10
|
|
|
9
11
|
## Installation
|
|
10
12
|
|
|
11
13
|
```bash
|
|
12
|
-
#
|
|
14
|
+
# Recommended — install and run with Bun
|
|
13
15
|
bun add -D @typescape-ai/cli
|
|
16
|
+
```
|
|
14
17
|
|
|
15
|
-
|
|
18
|
+
```bash
|
|
19
|
+
# Alternative: install via npm/pnpm/yarn (package installation only; Bun runtime still required)
|
|
16
20
|
npm install -D @typescape-ai/cli
|
|
17
21
|
```
|
|
18
22
|
|
|
23
|
+
> **Note:** Even if you install via npm, you must run the CLI with `bunx` or `bun run`. Running with `npx` will fail because the CLI depends on Bun-specific APIs.
|
|
24
|
+
|
|
19
25
|
## Quick Start
|
|
20
26
|
|
|
21
27
|
1. Initialize config in your repo:
|
|
@@ -33,7 +39,7 @@ export TYPESCAPE_API_KEY=your-token-here
|
|
|
33
39
|
3. Create a review session:
|
|
34
40
|
|
|
35
41
|
```bash
|
|
36
|
-
bunx typescape session create --file docs/README.md
|
|
42
|
+
bunx typescape session create --file docs/README.md --reviewer alice@example.com
|
|
37
43
|
```
|
|
38
44
|
|
|
39
45
|
4. Export feedback:
|
|
@@ -44,13 +50,63 @@ bunx typescape session export --session sess_xxx
|
|
|
44
50
|
|
|
45
51
|
## Commands
|
|
46
52
|
|
|
53
|
+
### Session Management
|
|
54
|
+
|
|
55
|
+
| Command | Description |
|
|
56
|
+
| ------------------- | ------------------------------------------------ |
|
|
57
|
+
| `session create` | Create a new review session |
|
|
58
|
+
| `session get` | Get session details |
|
|
59
|
+
| `session list` | List sessions with filters |
|
|
60
|
+
| `session export` | Export feedback as JSON |
|
|
61
|
+
| `session status` | Get policy verdict for a session |
|
|
62
|
+
| `session close` | Close a session |
|
|
63
|
+
| `session supersede` | Create a new session superseding an existing one |
|
|
64
|
+
|
|
65
|
+
### Threads & Comments
|
|
66
|
+
|
|
67
|
+
| Command | Description |
|
|
68
|
+
| -------------------- | ------------------------------------------ |
|
|
69
|
+
| `thread create` | Create a new thread on a block |
|
|
70
|
+
| `thread comment` | Post a reply to an existing thread |
|
|
71
|
+
| `thread list` | List threads for a session |
|
|
72
|
+
| `thread resolve` | Resolve a thread with optional disposition |
|
|
73
|
+
| `thread disposition` | Record a disposition on a thread |
|
|
74
|
+
| `thread evidence` | Attach evidence to a thread |
|
|
75
|
+
|
|
76
|
+
### Review & Approval
|
|
77
|
+
|
|
78
|
+
| Command | Description |
|
|
79
|
+
| ------------------ | ------------------------------------------------- |
|
|
80
|
+
| `approval` | Request or manage approvals |
|
|
81
|
+
| `review-ref` | Create, resolve, or advance review references |
|
|
82
|
+
| `revise` | Generate a revised document from session feedback |
|
|
83
|
+
| `proposed-changes` | Manage proposed changes |
|
|
84
|
+
| `checks run` | Run quality checks (DocLint) |
|
|
85
|
+
| `verify-export` | Validate an export against the schema |
|
|
86
|
+
|
|
87
|
+
### Guidelines & Steering
|
|
88
|
+
|
|
89
|
+
| Command | Description |
|
|
90
|
+
| ----------------- | --------------------------------------------- |
|
|
91
|
+
| `guidelines list` | List active steering rules |
|
|
92
|
+
| `guidelines get` | Get a specific steering rule |
|
|
93
|
+
| `guidelines pack` | Pack steering rules for LLM consumption |
|
|
94
|
+
| `gci create` | Create a guideline change item |
|
|
95
|
+
| `gci list` | List guideline change items |
|
|
96
|
+
| `gci decide` | Accept, reject, or deprecate a GCI proposal |
|
|
97
|
+
| `coverage` | Check section coverage against steering rules |
|
|
98
|
+
|
|
99
|
+
### Auth & Configuration
|
|
100
|
+
|
|
47
101
|
| Command | Description |
|
|
48
102
|
| ----------------- | ------------------------------------------- |
|
|
49
103
|
| `init` | Create `.typescape/config.yaml` |
|
|
50
104
|
| `config validate` | Validate config and show effective settings |
|
|
51
|
-
| `
|
|
52
|
-
| `
|
|
105
|
+
| `token generate` | Generate a new API token |
|
|
106
|
+
| `auth login` | Authenticate with the Typescape server |
|
|
53
107
|
| `smoke-test` | End-to-end sanity check |
|
|
108
|
+
| `anchors` | Inspect block anchors for a file |
|
|
109
|
+
| `ids` | Generate Typescape IDs |
|
|
54
110
|
|
|
55
111
|
## Configuration
|
|
56
112
|
|