tspl-cli 0.1.0 → 0.1.1
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 +100 -11
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,38 +2,127 @@
|
|
|
2
2
|
|
|
3
3
|
`tspl` is the command-line tool for the TSPL AI feature-development tool. It reads your repositories (no AI, nothing leaves your machine), turns a task into a clear brief, plans the change with you, enforces the approved plan while an AI tool builds it, runs the tests and opens the pull request.
|
|
4
4
|
|
|
5
|
+
```text
|
|
6
|
+
npm i -g tspl-cli → tspl setup → tspl init → tspl task new "…" → tspl t-xxxx → tspl plan approve t-xxxx → tspl task run t-xxxx
|
|
7
|
+
```
|
|
8
|
+
|
|
5
9
|
## Requirements
|
|
6
10
|
|
|
7
11
|
- Node 22 or newer
|
|
8
12
|
- git
|
|
9
|
-
-
|
|
13
|
+
- A TSPL account and the address of your TSPL API (ask your team)
|
|
14
|
+
- An AI tool such as Claude Code, Codex, Cursor or Gemini, using your own subscription
|
|
10
15
|
|
|
11
|
-
## Install
|
|
16
|
+
## 1. Install (once per computer)
|
|
12
17
|
|
|
13
18
|
```bash
|
|
14
19
|
npm install -g tspl-cli
|
|
15
|
-
tspl --
|
|
20
|
+
tspl --version
|
|
16
21
|
```
|
|
17
22
|
|
|
18
|
-
|
|
23
|
+
Update later with `npm install -g tspl-cli@latest`.
|
|
24
|
+
|
|
25
|
+
## 2. Configure (once per computer)
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
tspl setup --api https://<your-tspl-api> --connect claude
|
|
29
|
+
tspl whoami
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
`tspl setup` walks you through:
|
|
33
|
+
|
|
34
|
+
- logging in to the TSPL API with your email and password
|
|
35
|
+
- choosing which AI engine does each step
|
|
36
|
+
- connecting your AI tool: the `/tspl` command, the edit lock and the MCP plug-in
|
|
37
|
+
|
|
38
|
+
Connect other tools with `--connect codex cursor gemini antigravity vscode`, or later with `tspl connect <tool>`. Restart your AI tool after connecting it.
|
|
39
|
+
|
|
40
|
+
Several organizations:
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
tspl login --org <slug> # log in to a specific organization
|
|
44
|
+
tspl org use <slug> # switch to one you are already logged in to
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## 3. Set up a project (once per project folder)
|
|
48
|
+
|
|
49
|
+
Run inside the project folder:
|
|
19
50
|
|
|
20
51
|
```bash
|
|
21
|
-
tspl setup --api https://your-tspl-api.example.com # log in and check your machine
|
|
22
52
|
cd path/to/your/project
|
|
23
|
-
tspl init
|
|
24
|
-
|
|
25
|
-
|
|
53
|
+
tspl init
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
This links the folder to a TSPL project, finds its test and lint checks, and saves `.tspl/project.json`. Commit that file so the whole team shares the same rules. tspl then reads the code into a local map (no AI, nothing uploaded).
|
|
57
|
+
|
|
58
|
+
Running `tspl` with no arguments sets the folder up if needed, or shows its open tasks.
|
|
59
|
+
|
|
60
|
+
## 4. Work on a task
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
tspl task new "Add a Contact page at /contact" # answer a few questions; prints the task id, e.g. t-xxxx
|
|
64
|
+
tspl t-xxxx # compare approaches, pick one, write the plan
|
|
65
|
+
tspl plan show t-xxxx # files to edit, create and remove, and tests
|
|
66
|
+
tspl plan approve t-xxxx # developer approves, then the PM approves
|
|
67
|
+
tspl task run t-xxxx # code, run checks, repair, review, draft pull requests, CI
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
Other ways to start a task:
|
|
71
|
+
|
|
72
|
+
```bash
|
|
73
|
+
tspl task new --ticket TEST-1 "Add About page" # with a ticket id
|
|
74
|
+
tspl task new --file ticket.txt # ticket text from a file
|
|
26
75
|
```
|
|
27
76
|
|
|
28
|
-
`tspl
|
|
77
|
+
`tspl task run` asks which branch each repo starts from and the name of the new branch. Skip the questions with:
|
|
78
|
+
|
|
79
|
+
```bash
|
|
80
|
+
tspl task run t-xxxx --base main --branch feature/contact-page
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
Run `tspl task run t-xxxx` again to resume after a stop. To retry one stage, add `--stage testing` or `--stage reviewing`.
|
|
84
|
+
|
|
85
|
+
From your AI tool, type `/tspl <what should change>` to do the same steps there.
|
|
86
|
+
|
|
87
|
+
## Everyday commands
|
|
88
|
+
|
|
89
|
+
| What | Command |
|
|
90
|
+
| --- | --- |
|
|
91
|
+
| Where a task is and the next command | `tspl task status t-xxxx` |
|
|
92
|
+
| Tasks on this computer | `tspl task list` |
|
|
93
|
+
| Show a task brief | `tspl task show t-xxxx` |
|
|
94
|
+
| Change a task | `tspl task edit t-xxxx` |
|
|
95
|
+
| Plans waiting for a decision | `tspl plan list` |
|
|
96
|
+
| Send a plan back | `tspl plan reject t-xxxx --note "..."` |
|
|
97
|
+
| PM confirms scope / sends it back | `tspl task scope t-xxxx` / `tspl task scope t-xxxx --back --note "..."` |
|
|
98
|
+
| Keep going through approvals and CI | `tspl task watch t-xxxx` |
|
|
99
|
+
| Builds in progress | `tspl build status` |
|
|
100
|
+
| Stop a build and lift its edit lock | `tspl build stop t-xxxx` |
|
|
101
|
+
| Allow a new plan after a stop | `tspl plan amend t-xxxx` |
|
|
102
|
+
| Delete a task | `tspl task delete t-xxxx --reason "..."` |
|
|
103
|
+
| Who is logged in | `tspl whoami` |
|
|
104
|
+
| AI engine per step | `tspl engines` |
|
|
105
|
+
|
|
106
|
+
## Team and projects
|
|
107
|
+
|
|
108
|
+
```bash
|
|
109
|
+
tspl project list # projects you can see
|
|
110
|
+
tspl member list # people and their roles
|
|
111
|
+
tspl member add <email> # owner or admin
|
|
112
|
+
tspl member role <email> <role>
|
|
113
|
+
tspl project add-member <project> <email>
|
|
114
|
+
tspl project remove-member <project> <email>
|
|
115
|
+
```
|
|
29
116
|
|
|
30
117
|
## Where tspl keeps data
|
|
31
118
|
|
|
32
119
|
- `~/.tspl`: your login, settings and the local code map of each repo. The map is built from git and never uploaded.
|
|
33
120
|
- `.tspl/project.json` in your project: the project's checks and settings, meant to be committed.
|
|
121
|
+
- The TSPL server stores tasks, plans, approvals, reports and AI usage, never your code.
|
|
34
122
|
|
|
35
|
-
##
|
|
123
|
+
## Help
|
|
36
124
|
|
|
37
125
|
```bash
|
|
38
|
-
|
|
126
|
+
tspl --help
|
|
127
|
+
tspl <command> --help
|
|
39
128
|
```
|