specstocode 0.6.1 → 0.6.2
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 +23 -21
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -8,6 +8,8 @@ Write structured specs, map your user stories, and let your AI coding agent do t
|
|
|
8
8
|
npm install -g specstocode
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
+
Installs three aliases: **`stc`** (short, daily use), `specstocode`, and `productbuilders`.
|
|
12
|
+
|
|
11
13
|
Or use without installing:
|
|
12
14
|
|
|
13
15
|
```bash
|
|
@@ -17,7 +19,7 @@ npx specstocode init
|
|
|
17
19
|
## How it works
|
|
18
20
|
|
|
19
21
|
1. **Plan on the web** — create a project on [specstocode.com](https://specstocode.com), map your user stories, and write Gherkin specs for each one
|
|
20
|
-
2. **Connect your codebase** — run `specstocode init` in your project directory
|
|
22
|
+
2. **Connect your codebase** — run `npx specstocode init` in your project directory
|
|
21
23
|
3. **Build with AI** — your AI coding agent reads `SPECSTOCODE.md` for full product context: stories, acceptance criteria, decisions, and notes
|
|
22
24
|
|
|
23
25
|
```
|
|
@@ -40,7 +42,7 @@ specstocode.com Your project
|
|
|
40
42
|
### 1. Log in
|
|
41
43
|
|
|
42
44
|
```bash
|
|
43
|
-
|
|
45
|
+
stc login
|
|
44
46
|
```
|
|
45
47
|
|
|
46
48
|
Opens your browser to authenticate. One-time per machine.
|
|
@@ -50,7 +52,7 @@ Opens your browser to authenticate. One-time per machine.
|
|
|
50
52
|
Run this inside your project directory after creating a project on [specstocode.com](https://specstocode.com):
|
|
51
53
|
|
|
52
54
|
```bash
|
|
53
|
-
specstocode init
|
|
55
|
+
npx specstocode init
|
|
54
56
|
```
|
|
55
57
|
|
|
56
58
|
This creates:
|
|
@@ -60,7 +62,7 @@ This creates:
|
|
|
60
62
|
### 3. Set up your AI tool
|
|
61
63
|
|
|
62
64
|
```bash
|
|
63
|
-
|
|
65
|
+
stc setup
|
|
64
66
|
```
|
|
65
67
|
|
|
66
68
|
Configures [Claude Code](https://claude.com/claude-code) or [Cursor](https://cursor.com) with:
|
|
@@ -70,10 +72,10 @@ Configures [Claude Code](https://claude.com/claude-code) or [Cursor](https://cur
|
|
|
70
72
|
### 4. Build
|
|
71
73
|
|
|
72
74
|
```bash
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
75
|
+
stc next # What to build next (highest priority story + acceptance criteria)
|
|
76
|
+
stc done <id> # Mark a story complete
|
|
77
|
+
stc stories # List all stories
|
|
78
|
+
stc status # Progress dashboard
|
|
77
79
|
```
|
|
78
80
|
|
|
79
81
|
---
|
|
@@ -84,29 +86,29 @@ specstocode status # Progress dashboard
|
|
|
84
86
|
|
|
85
87
|
| Command | Description |
|
|
86
88
|
|---------|-------------|
|
|
87
|
-
| `
|
|
88
|
-
| `
|
|
89
|
-
| `
|
|
90
|
-
| `
|
|
91
|
-
| `
|
|
89
|
+
| `stc login` | Authenticate (opens browser) |
|
|
90
|
+
| `stc logout` | Log out |
|
|
91
|
+
| `stc init` | Connect project directory to a story map |
|
|
92
|
+
| `stc sync` | Refresh `SPECSTOCODE.md` with latest from the web |
|
|
93
|
+
| `stc setup` | Configure Claude Code / Cursor |
|
|
92
94
|
|
|
93
95
|
### Story management
|
|
94
96
|
|
|
95
97
|
| Command | Description |
|
|
96
98
|
|---------|-------------|
|
|
97
|
-
| `
|
|
98
|
-
| `
|
|
99
|
-
| `
|
|
100
|
-
| `
|
|
101
|
-
| `
|
|
102
|
-
| `
|
|
103
|
-
| `
|
|
99
|
+
| `stc status` | Progress dashboard |
|
|
100
|
+
| `stc stories [-f filter]` | List stories (filter: `todo` / `done` / keyword) |
|
|
101
|
+
| `stc next` | Next priority story with acceptance criteria |
|
|
102
|
+
| `stc done <id>` | Mark a story done (accepts ID prefix) |
|
|
103
|
+
| `stc add <title>` | Create a new story |
|
|
104
|
+
| `stc decide [title]` | Log an architectural decision |
|
|
105
|
+
| `stc note <id> [text]` | Add implementation notes to a story |
|
|
104
106
|
|
|
105
107
|
### MCP server
|
|
106
108
|
|
|
107
109
|
| Command | Description |
|
|
108
110
|
|---------|-------------|
|
|
109
|
-
| `
|
|
111
|
+
| `stc mcp [--mode]` | Start MCP server (`core` / `standard` / `all`) |
|
|
110
112
|
|
|
111
113
|
---
|
|
112
114
|
|