prjct-cli 0.35.4 → 0.37.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/CHANGELOG.md +84 -0
- package/README.md +64 -618
- package/bin/prjct.ts +128 -17
- package/core/agentic/template-executor.ts +14 -4
- package/core/cli/start.ts +397 -0
- package/core/commands/analysis.ts +6 -3
- package/core/commands/setup.ts +27 -17
- package/core/index.ts +101 -35
- package/core/infrastructure/ai-provider.ts +414 -0
- package/core/infrastructure/command-installer.ts +119 -42
- package/core/infrastructure/editors-config.ts +20 -6
- package/core/infrastructure/path-manager.ts +18 -9
- package/core/infrastructure/setup.ts +356 -62
- package/core/services/skill-service.ts +52 -16
- package/core/types/index.ts +12 -0
- package/core/types/provider.ts +134 -0
- package/core/utils/branding.ts +20 -3
- package/dist/bin/prjct.mjs +1482 -2763
- package/dist/core/infrastructure/command-installer.js +33 -2
- package/dist/core/infrastructure/editors-config.js +13 -3
- package/dist/core/infrastructure/setup.js +293 -73
- package/package.json +9 -9
- package/scripts/postinstall.js +17 -119
- package/templates/_bases/tracker-base.md +7 -5
- package/templates/agents/AGENTS.md +9 -1
- package/templates/commands/github.md +7 -5
- package/templates/commands/init.md +16 -0
- package/templates/commands/jira.md +8 -6
- package/templates/commands/linear.md +8 -6
- package/templates/commands/monday.md +8 -6
- package/templates/commands/p.md +1 -1
- package/templates/commands/p.toml +37 -0
- package/templates/commands/sync.md +11 -1
- package/templates/cursor/p.md +29 -0
- package/templates/cursor/router.mdc +28 -0
- package/templates/global/CLAUDE.md +33 -1
- package/templates/global/CURSOR.mdc +233 -0
- package/templates/global/GEMINI.md +265 -0
- package/templates/global/STORAGE-SPEC.md +256 -0
- package/templates/global/docs/agents.md +88 -0
- package/templates/global/docs/architecture.md +103 -0
- package/templates/global/docs/commands.md +96 -0
- package/templates/global/docs/validation.md +95 -0
package/README.md
CHANGED
|
@@ -1,655 +1,101 @@
|
|
|
1
|
-
|
|
2
|
-
██████╗ ██████╗ ██╗ ██████╗████████╗
|
|
3
|
-
██╔══██╗██╔══██╗ ██║██╔════╝╚══██╔══╝
|
|
4
|
-
██████╔╝██████╔╝ ██║██║ ██║
|
|
5
|
-
██╔═══╝ ██╔══██╗██ ██║██║ ██║
|
|
6
|
-
██║ ██║ ██║╚█████╔╝╚██████╗ ██║
|
|
7
|
-
╚═╝ ╚═╝ ╚═╝ ╚════╝ ╚═════╝ ╚═╝
|
|
8
|
-
prjct/cli
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
**Ship fast, track progress, stay focused.**
|
|
12
|
-
|
|
13
|
-
Developer momentum tool for indie hackers and small teams.
|
|
14
|
-
|
|
15
|
-
[](CLAUDE.md)
|
|
16
|
-
[]()
|
|
17
|
-
[](https://github.com/jlopezlira/prjct-cli/actions/workflows/test.yml)
|
|
18
|
-
[](https://prjct.app)
|
|
19
|
-
|
|
20
|
-
> **New to prjct?** You don't need to memorize commands. Just use `p.` and talk naturally:
|
|
21
|
-
> - `p. start working on user auth`
|
|
22
|
-
> - `p. I'm done`
|
|
23
|
-
> - `p. ship the authentication`
|
|
24
|
-
|
|
25
|
-
## What prjct is (and isn't)
|
|
1
|
+
# prjct
|
|
26
2
|
|
|
27
|
-
**
|
|
3
|
+
**Context layer for AI coding agents.**
|
|
28
4
|
|
|
29
|
-
|
|
30
|
-
|---------------|-----------|
|
|
31
|
-
| Write code for you | Tracks what you're building |
|
|
32
|
-
| Replace your IDE | Enhances Claude Code |
|
|
33
|
-
| Multi-provider (GPT, Claude, etc.) | 100% Claude-optimized |
|
|
34
|
-
| Compete with Cursor, Copilot | Replaces Jira, Linear, Notion |
|
|
5
|
+
Works with Claude Code, Gemini CLI, Cursor IDE, and more.
|
|
35
6
|
|
|
36
|
-
|
|
7
|
+
[](CLAUDE.md)
|
|
8
|
+
[]()
|
|
9
|
+
[]()
|
|
10
|
+
[](https://www.npmjs.com/package/prjct-cli)
|
|
37
11
|
|
|
38
|
-
##
|
|
12
|
+
## What is prjct?
|
|
39
13
|
|
|
40
|
-
|
|
14
|
+
prjct gives AI coding agents the context they need about your project. It maintains state between sessions, tracks progress, and ensures agents understand your codebase.
|
|
41
15
|
|
|
42
|
-
The system detects your intent and maps it to the right command - **works in any language**:
|
|
43
|
-
|
|
44
|
-
```
|
|
45
|
-
Instead of: Just say:
|
|
46
|
-
/p:now "implement auth" → "p. I want to start building the auth system"
|
|
47
|
-
/p:done → "p. I'm done" or "p. finished"
|
|
48
|
-
/p:ship "feature" → "p. ship the authentication"
|
|
49
|
-
/p:stuck "error" → "p. I'm stuck on this error"
|
|
50
|
-
/p:idea "add feature" → "p. I have an idea about dark mode"
|
|
51
16
|
```
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
- **Dynamic AI Agents** - Auto-generated specialists based on your stack
|
|
66
|
-
- **MCP Integration** - Native Model Context Protocol support
|
|
67
|
-
- **Slash Commands** - `/p:*` commands in Claude Code and Desktop
|
|
68
|
-
- **Git Validation** - Last commit as source of truth
|
|
69
|
-
- **Natural Language** - Talk naturally, commands adapt
|
|
70
|
-
|
|
71
|
-
### Why Claude-Only?
|
|
72
|
-
|
|
73
|
-
We chose to focus 100% on Claude to deliver:
|
|
74
|
-
|
|
75
|
-
- **Deep Integration** - Leverage Claude's agent system and MCP
|
|
76
|
-
- **Better Quality** - Optimized for Claude's strengths
|
|
77
|
-
- **Simpler Codebase** - No multi-platform compromises
|
|
78
|
-
- **Honest Compatibility** - We only support what we can validate
|
|
79
|
-
|
|
80
|
-
## ⚡ Installation
|
|
81
|
-
|
|
82
|
-
### Using Bun (Recommended)
|
|
83
|
-
|
|
84
|
-
prjct-cli is built with Bun for maximum performance:
|
|
85
|
-
|
|
86
|
-
```bash
|
|
87
|
-
bun install -g prjct-cli
|
|
17
|
+
Your AI Agent (Claude/Gemini/Cursor) prjct
|
|
18
|
+
│ │
|
|
19
|
+
│ "What am I working on?" │
|
|
20
|
+
│ ───────────────────────────────► │
|
|
21
|
+
│ │ Reads project context
|
|
22
|
+
│ Task: "Add user auth" │
|
|
23
|
+
│ Branch: feature/auth │
|
|
24
|
+
│ Subtask 2/5: API routes │
|
|
25
|
+
│ ◄─────────────────────────────── │
|
|
26
|
+
│ │
|
|
27
|
+
▼ │
|
|
28
|
+
Writes code with full context │
|
|
88
29
|
```
|
|
89
30
|
|
|
90
|
-
|
|
31
|
+
## Install
|
|
91
32
|
|
|
92
33
|
```bash
|
|
93
|
-
# Using npm
|
|
94
34
|
npm install -g prjct-cli
|
|
95
|
-
|
|
96
|
-
# Using yarn
|
|
97
|
-
yarn global add prjct-cli
|
|
98
|
-
|
|
99
|
-
# Using pnpm
|
|
100
|
-
pnpm add -g prjct-cli
|
|
101
|
-
```
|
|
102
|
-
|
|
103
|
-
### From GitHub Packages
|
|
104
|
-
|
|
105
|
-
You can also install from GitHub Packages:
|
|
106
|
-
|
|
107
|
-
```bash
|
|
108
|
-
npm install -g @jlopezlira/prjct-cli --registry=https://npm.pkg.github.com
|
|
109
|
-
```
|
|
110
|
-
|
|
111
|
-
For easier installation from GitHub Packages, see [GitHub Packages Setup](docs/GITHUB_PACKAGES.md).
|
|
112
|
-
|
|
113
|
-
**Requirements**: Bun 1.0+ or Node.js 18+
|
|
114
|
-
|
|
115
|
-
> **Note**: The CLI automatically detects updates and notifies you when a new version is available. Simply run `npm update -g prjct-cli` to upgrade.
|
|
116
|
-
|
|
117
|
-
### Auto-Setup (NEW in v0.8.2)
|
|
118
|
-
|
|
119
|
-
After `npm install -g prjct-cli`, setup runs automatically:
|
|
120
|
-
|
|
121
|
-
- ✅ Installs `/p:*` commands to `~/.claude`
|
|
122
|
-
- ✅ Migrates legacy projects to global storage
|
|
123
|
-
- ✅ Syncs commands (removes orphans, adds new ones)
|
|
124
|
-
- ✅ Shows beautiful ASCII art with quick start
|
|
125
|
-
|
|
126
|
-
**That's it!** No manual setup required.
|
|
127
|
-
|
|
128
|
-
If you need to reconfigure later:
|
|
129
|
-
|
|
130
|
-
```bash
|
|
131
|
-
prjct setup # Reconfigure and sync commands
|
|
132
|
-
prjct setup --force # Force reinstall all commands
|
|
133
|
-
```
|
|
134
|
-
|
|
135
|
-
**Installation Location**: `~/.claude/commands/p/`
|
|
136
|
-
|
|
137
|
-
All 25+ slash commands (`/p:*`) are automatically installed to Claude Code and Claude Desktop.
|
|
138
|
-
|
|
139
|
-
### Version Management
|
|
140
|
-
|
|
141
|
-
The installer automatically:
|
|
142
|
-
|
|
143
|
-
- **Detects existing installations** and checks for updates
|
|
144
|
-
- **Compares versions** between local and remote
|
|
145
|
-
- **Prompts for updates** when newer versions are available
|
|
146
|
-
- **Shows current version** during installation
|
|
147
|
-
- **Supports force reinstall** with `--force` flag
|
|
148
|
-
|
|
149
|
-
### Manual Installation
|
|
150
|
-
|
|
151
|
-
```bash
|
|
152
|
-
git clone https://github.com/jlopezlira/prjct-cli
|
|
153
|
-
cd prjct-cli
|
|
154
|
-
./setup.sh
|
|
155
|
-
```
|
|
156
|
-
|
|
157
|
-
### What the Installer Does
|
|
158
|
-
|
|
159
|
-
- ✅ **Installs to** `~/.prjct-cli/`
|
|
160
|
-
- ✅ **Checks prerequisites** (Node.js 18+, Git)
|
|
161
|
-
- ✅ **Detects Claude** (Code or Desktop)
|
|
162
|
-
- ✅ **Installs slash commands** to `~/.claude/commands/p/`
|
|
163
|
-
- ✅ **Creates global structure** in `~/.prjct-cli/`
|
|
164
|
-
- ✅ **Version management** with automatic update detection
|
|
165
|
-
- ✅ **Configures MCP integration** (Context7, Sequential, Magic, Playwright)
|
|
166
|
-
- ✅ **Sets up the** `prjct` **command**
|
|
167
|
-
- ✅ **Creates project structure** in `.prjct/`
|
|
168
|
-
- ✅ **Auto-detects your environment** (Claude or Terminal fallback)
|
|
169
|
-
- ✅ **Configures shell** (bash/zsh) automatically
|
|
170
|
-
|
|
171
|
-
## ⚡ 5-Minute Quick Start
|
|
172
|
-
|
|
173
|
-
Get productive with prjct-cli in under 5 minutes.
|
|
174
|
-
|
|
175
|
-
### Step 1: Initialize Your Project
|
|
176
|
-
|
|
177
|
-
```bash
|
|
178
|
-
cd your-project
|
|
179
|
-
```
|
|
180
|
-
|
|
181
|
-
In Claude Code or Claude Desktop:
|
|
182
|
-
```
|
|
183
|
-
/p:init
|
|
184
|
-
```
|
|
185
|
-
|
|
186
|
-
Or just say: `p. initialize this project`
|
|
187
|
-
|
|
188
|
-
### Step 2: Start Your First Task
|
|
189
|
-
|
|
190
|
-
```
|
|
191
|
-
/p:now "implement user login"
|
|
192
|
-
```
|
|
193
|
-
|
|
194
|
-
Or naturally: `p. I want to start working on user login`
|
|
195
|
-
|
|
196
|
-
### Step 3: Work on Your Task
|
|
197
|
-
|
|
198
|
-
Just code! prjct tracks your focus.
|
|
199
|
-
|
|
200
|
-
### Step 4: Complete Your Task
|
|
201
|
-
|
|
202
|
-
```
|
|
203
|
-
/p:done
|
|
204
|
-
```
|
|
205
|
-
|
|
206
|
-
Or naturally: `p. finished`
|
|
207
|
-
|
|
208
|
-
### Step 5: Ship It!
|
|
209
|
-
|
|
210
|
-
```
|
|
211
|
-
/p:ship "user authentication"
|
|
212
|
-
```
|
|
213
|
-
|
|
214
|
-
Or naturally: `p. ship the authentication`
|
|
215
|
-
|
|
216
|
-
**That's it!** You now know the core workflow.
|
|
217
|
-
|
|
218
|
-
### What's Next?
|
|
219
|
-
|
|
220
|
-
- `/p:recap` - See your progress
|
|
221
|
-
- `/p:help` - Get contextual guidance
|
|
222
|
-
- `/p:idea "something cool"` - Capture ideas without interrupting
|
|
223
|
-
|
|
224
|
-
> **Pro tip:** You don't need to memorize commands. Just use `p.` and describe what you want!
|
|
225
|
-
|
|
226
|
-
## 🚀 Built for Claude - Ship Fast, No BS
|
|
227
|
-
|
|
228
|
-
### Track Progress, Not Meetings
|
|
229
|
-
|
|
230
|
-
**prjct-cli helps you ship products fast.** Built for creators and small teams who prefer coding over meetings.
|
|
231
|
-
|
|
232
|
-
**What it does:**
|
|
233
|
-
|
|
234
|
-
- ✅ Track what you're working on
|
|
235
|
-
- ✅ See what you've shipped
|
|
236
|
-
- ✅ Stay focused on one thing
|
|
237
|
-
- ✅ No meetings needed
|
|
238
|
-
|
|
239
|
-
**What it doesn't do:**
|
|
240
|
-
|
|
241
|
-
- ❌ Not like Jira or ClickUp
|
|
242
|
-
- ❌ No sprint planning
|
|
243
|
-
- ❌ No story points
|
|
244
|
-
- ❌ No charts or reports
|
|
245
|
-
- ❌ No meetings
|
|
246
|
-
|
|
247
|
-
**Philosophy: Just Ship It**
|
|
248
|
-
|
|
249
|
-
```
|
|
250
|
-
/p:now "build auth" → Focus
|
|
251
|
-
work work work → Ship
|
|
252
|
-
/p:done → Next
|
|
253
|
-
/p:ship "authentication" → Celebrate
|
|
254
|
-
```
|
|
255
|
-
|
|
256
|
-
No planning sessions. No standups. No retrospectives. Just **ship fast, track progress, stay focused**.
|
|
257
|
-
|
|
258
|
-
**Who uses this:**
|
|
259
|
-
|
|
260
|
-
- 🎯 **Solo creators** - Build products without meetings or BS overhead
|
|
261
|
-
- 👥 **Small teams** (2-5 people) - Coordinate without meetings
|
|
262
|
-
- 🚀 **Product builders** - Ship features fast
|
|
263
|
-
- 💪 **Makers** - Focus on building, not planning
|
|
264
|
-
|
|
265
|
-
### Why 100% Claude-Focused?
|
|
266
|
-
|
|
267
|
-
**This isn't a limitation - it's a superpower.**
|
|
268
|
-
|
|
269
|
-
By focusing exclusively on Claude Code and Claude Desktop, we can build features that would be impossible with multi-platform support:
|
|
270
|
-
|
|
271
|
-
**🤖 Smart AI Helpers**
|
|
272
|
-
|
|
273
|
-
- Get help from specialized AI assistants (for frontend, backend, UX, security, etc.)
|
|
274
|
-
- They activate automatically when you need them
|
|
275
|
-
- Works with Claude's AI system
|
|
276
|
-
|
|
277
|
-
**🔗 AI Tools Built-In**
|
|
278
|
-
|
|
279
|
-
- Context7 - Gets documentation for any library automatically
|
|
280
|
-
- Sequential - Helps solve complex problems
|
|
281
|
-
- Magic - Creates UI components for you
|
|
282
|
-
- Playwright - Tests your app in a real browser
|
|
283
|
-
|
|
284
|
-
**✅ Code Change Verification**
|
|
285
|
-
|
|
286
|
-
- Checks your actual code changes
|
|
287
|
-
- Makes sure you actually completed what you said
|
|
288
|
-
- No fake progress
|
|
289
|
-
|
|
290
|
-
**💬 Talk Naturally**
|
|
291
|
-
|
|
292
|
-
- Just describe what you want to do
|
|
293
|
-
- Works in any language
|
|
294
|
-
- No commands to memorize
|
|
295
|
-
|
|
296
|
-
**Why it works better:**
|
|
297
|
-
|
|
298
|
-
- ⚡ **Simpler code** - Faster to add features and fix bugs
|
|
299
|
-
- 🎯 **Built for Claude** - Uses Claude's special features
|
|
300
|
-
- 💯 **Everything tested** - We only support what actually works
|
|
301
|
-
- 🤝 **Honest about compatibility** - We tell you what works and what doesn't
|
|
302
|
-
|
|
303
|
-
**See [MIGRATION.md](MIGRATION.md) for v0.5.0 upgrade guide.**
|
|
304
|
-
|
|
305
|
-
## 📱 Platform Usage
|
|
306
|
-
|
|
307
|
-
### Claude Code & Claude Desktop
|
|
308
|
-
|
|
309
|
-
Built exclusively for Claude with native slash commands:
|
|
310
|
-
|
|
311
|
-
```
|
|
312
|
-
# Core Commands (or just talk naturally!)
|
|
313
|
-
/p:init # Initialize project
|
|
314
|
-
/p:now "implement auth" # Set current task
|
|
315
|
-
/p:done # Complete task
|
|
316
|
-
/p:ship "authentication" # Ship feature
|
|
317
|
-
/p:recap # Show progress
|
|
318
|
-
|
|
319
|
-
# Power Commands 🚀
|
|
320
|
-
/p:analyze # Auto-analyze codebase
|
|
321
|
-
/p:git # Smart git commit with context
|
|
322
|
-
/p:fix "error msg" # Quick troubleshooting
|
|
323
|
-
/p:test # Run & fix tests
|
|
324
|
-
/p:task "complex feature" # Break down & execute
|
|
325
|
-
/p:roadmap # Strategic planning
|
|
35
|
+
prjct start
|
|
326
36
|
```
|
|
327
37
|
|
|
328
|
-
|
|
38
|
+
## Usage
|
|
329
39
|
|
|
330
|
-
|
|
40
|
+
Inside Claude Code, Gemini CLI, or Cursor IDE, use the `p.` prefix:
|
|
331
41
|
|
|
332
|
-
```bash
|
|
333
|
-
prjct init # Initialize project
|
|
334
|
-
prjct now "implement auth" # Set current task
|
|
335
|
-
prjct done # Complete task
|
|
336
|
-
prjct ship "authentication" # Ship feature
|
|
337
|
-
prjct recap # Show progress
|
|
338
42
|
```
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
**New idea or feature:**
|
|
345
|
-
|
|
346
|
-
- `/p:idea "add dark mode"` - Quick capture
|
|
347
|
-
- `/p:now "implement dark mode"` - Start working now
|
|
348
|
-
|
|
349
|
-
**Finished working:**
|
|
350
|
-
|
|
351
|
-
- `/p:done` - Mark complete, clear focus
|
|
352
|
-
- `/p:ship "feature name"` - Celebrate important milestones
|
|
353
|
-
|
|
354
|
-
**Lost context:**
|
|
355
|
-
|
|
356
|
-
- `/p:recap` - Complete overview
|
|
357
|
-
- `/p:next` - View task queue
|
|
358
|
-
|
|
359
|
-
**Need help:**
|
|
360
|
-
|
|
361
|
-
- `/p:stuck "error description"` - Get contextual solutions
|
|
362
|
-
- `/p:fix "error message"` - Auto-diagnosis
|
|
363
|
-
|
|
364
|
-
**Track progress:**
|
|
365
|
-
|
|
366
|
-
- `/p:progress week` - Weekly metrics
|
|
367
|
-
- `/p:context` - Project info
|
|
368
|
-
|
|
369
|
-
**Code quality:**
|
|
370
|
-
|
|
371
|
-
- `/p:cleanup` - Basic cleanup
|
|
372
|
-
- `/p:cleanup --type code` - Remove dead code, unused imports
|
|
373
|
-
- `/p:design "component" --type architecture` - Design before coding
|
|
374
|
-
|
|
375
|
-
**Version control:**
|
|
376
|
-
|
|
377
|
-
- `/p:git` - Smart commit
|
|
378
|
-
- `/p:git push` - Commit + push
|
|
379
|
-
|
|
380
|
-
**After cloning/pulling:**
|
|
381
|
-
|
|
382
|
-
- `/p:analyze` - Auto-analyze codebase
|
|
383
|
-
- `/p:analyze --sync` - Sync with implemented features
|
|
384
|
-
|
|
385
|
-
> 💡 **Tip:** Visit [prjct.app/commands](https://prjct.app/commands) for interactive command guide or [prjct.app/workflows-guide](https://prjct.app/workflows-guide) for step-by-step examples
|
|
386
|
-
|
|
387
|
-
## 📖 Complete Command Reference
|
|
388
|
-
|
|
389
|
-
### Core Commands (Essential) 🎯
|
|
390
|
-
|
|
391
|
-
| Command | When to use? | What does it do? | Example Output |
|
|
392
|
-
| ------------------- | ----------------------------- | ------------------------------------ | ----------------------------------------- |
|
|
393
|
-
| `/p:init` | Starting a new project | Creates complete `.prjct/` structure | `✅ Project initialized!` |
|
|
394
|
-
| `/p:now [task]` | To set your current focus | Defines ONE single active task | `🎯 Current: implement auth` |
|
|
395
|
-
| `/p:done` | When finishing current task | Marks complete and clears focus | `✅ Task complete! Next: API integration` |
|
|
396
|
-
| `/p:ship <feature>` | When completing something big | Celebrates and records the WIN | `🚀 SHIPPED: User auth! 🎉` |
|
|
397
|
-
| `/p:recap` | To see complete overview | Shows progress and current state | `📊 3 shipped, 1 active, 5 queued` |
|
|
398
|
-
|
|
399
|
-
### Planning Commands 📋
|
|
400
|
-
|
|
401
|
-
| Command | When to use? | What does it do? | Example Output |
|
|
402
|
-
| ------------------- | ----------------------- | ---------------------------------- | ------------------------------ |
|
|
403
|
-
| `/p:idea <text>` | When you have an idea | Quick capture without interrupting | `💡 Idea captured!` |
|
|
404
|
-
| `/p:roadmap` | View strategic plan | Shows complete roadmap | `🚀 Sprint: 23% complete` |
|
|
405
|
-
| `/p:roadmap add` | Add new feature | Automatically prioritizes | `✅ Added: Priority #3` |
|
|
406
|
-
| `/p:next` | See what's next | Lists prioritized tasks | `1. Fix auth bug 2. Add tests` |
|
|
407
|
-
| `/p:task <complex>` | Break down complex task | Divides into manageable subtasks | `📋 Split into 5 subtasks` |
|
|
408
|
-
|
|
409
|
-
### Development Commands 🛠️
|
|
410
|
-
|
|
411
|
-
| Command | When to use? | What does it do? | Example Output |
|
|
412
|
-
| ------------------- | ------------------------ | ---------------------------------- | ------------------------------------- |
|
|
413
|
-
| `/p:analyze` | Understand project state | Auto-analyze & sync with real code | `🔍 14 commands, 8 features detected` |
|
|
414
|
-
| `/p:analyze --sync` | After git pull or clone | Sync .prjct/ with implemented code | `✅ Synced 5 tasks, 3 features` |
|
|
415
|
-
| `/p:git` | Quick commit | Smart message + commit | `✅ feat: add auth system` |
|
|
416
|
-
| `/p:test` | Run tests | Run + auto-fix simple errors | `✅ 42 passing, 2 fixed` |
|
|
417
|
-
| `/p:fix <error>` | Solve errors | Diagnosis and solutions | `🔧 Solution: check null first` |
|
|
418
|
-
|
|
419
|
-
### Metrics Commands 📊
|
|
420
|
-
|
|
421
|
-
| Command | When to use? | What does it do? | Example Output |
|
|
422
|
-
| ------------------ | ------------------ | ------------------------- | --------------------------------- |
|
|
423
|
-
| `/p:progress` | View productivity | Weekly metrics | `📈 7 shipped, velocity: 1.4/day` |
|
|
424
|
-
| `/p:context` | Project info | Current state and context | `📚 Sprint 3, Day 12, 67% done` |
|
|
425
|
-
| `/p:stuck <issue>` | When you need help | Contextual solutions | `💡 Try: npm install cors` |
|
|
426
|
-
|
|
427
|
-
## 🔄 Common Workflows
|
|
428
|
-
|
|
429
|
-
**First day:** `/p:init` → `/p:recap` → `/p:now "first task"`
|
|
430
|
-
|
|
431
|
-
**Daily session:** `/p:recap` → Work → `/p:done` → `/p:git` → `/p:progress`
|
|
432
|
-
|
|
433
|
-
**Complex features:** `/p:task "feature"` → Break into subtasks → `/p:now` each → `/p:ship` when complete
|
|
434
|
-
|
|
435
|
-
**Sprint planning:** `/p:roadmap` → Add features → `/p:now` top priority → `/p:ship` → `/p:roadmap next`
|
|
436
|
-
|
|
437
|
-
> 📚 **More workflows:** Visit [prjct.app/workflows-guide](https://prjct.app/workflows-guide) for detailed interactive examples
|
|
438
|
-
|
|
439
|
-
## 🧪 Testing
|
|
440
|
-
|
|
441
|
-
prjct-cli uses **Bun** (`bun test`) for unit tests.
|
|
442
|
-
|
|
443
|
-
### Quick Start
|
|
444
|
-
|
|
445
|
-
```bash
|
|
446
|
-
# Run all tests
|
|
447
|
-
bun test
|
|
448
|
-
|
|
449
|
-
# Run tests in watch mode
|
|
450
|
-
bun test --watch
|
|
451
|
-
|
|
452
|
-
# Generate coverage report
|
|
453
|
-
bun test --coverage
|
|
43
|
+
p. sync # Analyze project, generate agents
|
|
44
|
+
p. task "add user auth" # Start a task
|
|
45
|
+
p. done # Complete current subtask
|
|
46
|
+
p. ship "user auth" # Ship with PR + version bump
|
|
454
47
|
```
|
|
455
48
|
|
|
456
|
-
###
|
|
457
|
-
|
|
458
|
-
- **Core CLI** (Node.js) - Agentic system, commands, and utilities
|
|
459
|
-
|
|
460
|
-
### CI/CD
|
|
461
|
-
|
|
462
|
-
Tests run automatically on every push and pull request via GitHub Actions.
|
|
463
|
-
|
|
464
|
-
[](https://github.com/jlopezlira/prjct-cli/actions/workflows/test.yml)
|
|
465
|
-
|
|
466
|
-
> 📖 **Full testing guide:** See [docs/TESTING.md](docs/TESTING.md) for detailed documentation, configuration, and best practices.
|
|
467
|
-
|
|
468
|
-
## ❓ FAQ
|
|
469
|
-
|
|
470
|
-
**Can I work on multiple tasks?**
|
|
471
|
-
No, by design. Single-focus philosophy. Use `/p:done` before switching.
|
|
472
|
-
|
|
473
|
-
**Difference between `/p:done` and `/p:ship`?**
|
|
474
|
-
`/p:done` clears focus. `/p:ship` celebrates important features with metrics.
|
|
475
|
-
|
|
476
|
-
**Where is my data stored?**
|
|
477
|
-
Everything is local in `~/.prjct-cli/projects/{id}/`. Never leaves your machine.
|
|
478
|
-
|
|
479
|
-
**Does it work with teams?**
|
|
480
|
-
Designed for creators and small teams (2-5 people). Each member has their own local data in `~/.prjct-cli/projects/{id}/`, with shared `.prjct/prjct.config.json` in the repo for project identification.
|
|
481
|
-
|
|
482
|
-
**How do I migrate from Jira/Trello?**
|
|
483
|
-
No migration needed. Just `/p:init` and start working.
|
|
484
|
-
|
|
485
|
-
> 💬 **More questions?** Check [prjct.app/faq](https://prjct.app/faq) or [open an issue](https://github.com/jlopezlira/prjct-cli/issues)
|
|
486
|
-
|
|
487
|
-
## 📂 File Structure
|
|
488
|
-
|
|
489
|
-
### New Layered Architecture 🏗️
|
|
49
|
+
### Core Workflow
|
|
490
50
|
|
|
491
51
|
```
|
|
492
|
-
.
|
|
493
|
-
├── 🎯 core/ # Current focus & priorities
|
|
494
|
-
│ ├── now.md # Current task
|
|
495
|
-
│ ├── next.md # Priority queue
|
|
496
|
-
│ └── context.md # Project context
|
|
497
|
-
├── 📈 progress/ # Metrics & achievements
|
|
498
|
-
│ ├── shipped.md # Completed features
|
|
499
|
-
│ └── metrics.md # Velocity & stats
|
|
500
|
-
├── 💡 planning/ # Ideas & strategy
|
|
501
|
-
│ ├── ideas.md # Brain dump
|
|
502
|
-
│ ├── roadmap.md # Strategic planning
|
|
503
|
-
│ └── tasks/ # Complex task plans
|
|
504
|
-
├── 🔍 analysis/ # Technical insights
|
|
505
|
-
│ └── repo-summary.md # Auto-generated
|
|
506
|
-
└── 🧠 memory/ # History & learning
|
|
507
|
-
├── context.jsonl # Activity log
|
|
508
|
-
└── decisions.jsonl # Decision history
|
|
52
|
+
p. sync → p. task "..." → [code] → p. done → p. ship
|
|
509
53
|
```
|
|
510
54
|
|
|
511
|
-
##
|
|
512
|
-
|
|
513
|
-
- **Zero friction**: Commands within your existing workflow
|
|
514
|
-
- **Single task focus**: One thing at a time
|
|
515
|
-
- **Celebration built-in**: Every ship is a win
|
|
516
|
-
- **No ceremonies**: No sprints, no story points, no meetings
|
|
517
|
-
|
|
518
|
-
## 📊 What We Track
|
|
519
|
-
|
|
520
|
-
✅ **Features shipped** - The only metric that matters
|
|
521
|
-
✅ **Current focus** - Stay on track
|
|
522
|
-
✅ **Ideas captured** - Never lose a thought
|
|
523
|
-
❌ ~~Story points~~ - We ship, not estimate
|
|
524
|
-
❌ ~~Hours logged~~ - Focus on outcomes
|
|
525
|
-
❌ ~~Burndown charts~~ - Ship and celebrate
|
|
526
|
-
|
|
527
|
-
## 🛠️ Requirements
|
|
528
|
-
|
|
529
|
-
- **Node.js 18+** - Required for CLI operation
|
|
530
|
-
- **Claude Code or Claude Desktop** - Recommended for full features (works with free tier or Pro)
|
|
531
|
-
- **Terminal/CLI** - Fallback mode (limited features)
|
|
532
|
-
|
|
533
|
-
### What You Get
|
|
534
|
-
|
|
535
|
-
**With Claude Code/Desktop (Recommended):**
|
|
536
|
-
|
|
537
|
-
- ✅ Smart AI helpers for different tasks
|
|
538
|
-
- ✅ AI tools that help you code
|
|
539
|
-
- ✅ Checks your actual code changes
|
|
540
|
-
- ✅ Talk naturally - no commands to memorize
|
|
541
|
-
- ✅ Use slash commands (`/p:*`) in Claude
|
|
542
|
-
- ✅ Everything works
|
|
543
|
-
|
|
544
|
-
**With Terminal/CLI Only:**
|
|
545
|
-
|
|
546
|
-
- ⚠️ Basic commands work (`prjct now`, `prjct done`, etc.)
|
|
547
|
-
- ❌ No AI helpers
|
|
548
|
-
- ❌ No AI tools
|
|
549
|
-
- ❌ Can't talk naturally
|
|
550
|
-
- ❌ Doesn't check code changes
|
|
551
|
-
- ❌ Many features missing
|
|
552
|
-
|
|
553
|
-
**Get Claude Code at https://claude.ai/code** - Works with whatever subscription you have (free tier or Pro). No extra costs, tokens, or API keys to configure.
|
|
554
|
-
|
|
555
|
-
## ❓ FAQ
|
|
556
|
-
|
|
557
|
-
### Why Claude-only? What about Cursor/Windsurf?
|
|
558
|
-
|
|
559
|
-
**TL;DR**: By focusing 100% on Claude, we deliver features that would be impossible with multi-platform support.
|
|
560
|
-
|
|
561
|
-
**The Long Answer:**
|
|
562
|
-
|
|
563
|
-
Starting with v0.5.0, prjct-cli only supports Claude Code and Claude Desktop. This isn't a limitation - **it's a strategic decision that makes the tool better**.
|
|
564
|
-
|
|
565
|
-
**What We Gain:**
|
|
566
|
-
|
|
567
|
-
1. **🤖 Smart AI Helpers** - Get specialized help (for frontend, backend, UX, security, etc.) that activates automatically. Only works with Claude's AI system.
|
|
568
|
-
|
|
569
|
-
2. **🔗 AI Tools Built-In** - Gets library docs automatically, helps solve complex problems, creates UI components, and tests your app in a browser. Only works with Claude.
|
|
570
|
-
|
|
571
|
-
3. **✅ Code Change Verification** - Checks your actual code changes to make sure you completed what you said. Needs Claude to work.
|
|
55
|
+
## How It Works
|
|
572
56
|
|
|
573
|
-
|
|
57
|
+
| Component | Claude Code | Gemini CLI | Cursor IDE |
|
|
58
|
+
|-----------|-------------|------------|------------|
|
|
59
|
+
| Router | `~/.claude/commands/p.md` | `~/.gemini/commands/p.toml` | `.cursor/commands/p.md` |
|
|
60
|
+
| Config | `~/.claude/CLAUDE.md` | `~/.gemini/GEMINI.md` | `.cursor/rules/prjct.mdc` |
|
|
61
|
+
| Storage | `~/.prjct-cli/projects/` | `~/.prjct-cli/projects/` | `~/.prjct-cli/projects/` |
|
|
62
|
+
| Scope | Global | Global | Per-project |
|
|
574
63
|
|
|
575
|
-
|
|
64
|
+
All agents share the same project storage, so you can switch between them freely.
|
|
576
65
|
|
|
577
|
-
|
|
66
|
+
## Commands
|
|
578
67
|
|
|
579
|
-
|
|
68
|
+
| Command | Description |
|
|
69
|
+
|---------|-------------|
|
|
70
|
+
| `p. sync` | Analyze project, generate domain agents |
|
|
71
|
+
| `p. task "desc"` | Start task with auto-classification |
|
|
72
|
+
| `p. done` | Complete current subtask |
|
|
73
|
+
| `p. ship "name"` | Ship feature with PR + version bump |
|
|
74
|
+
| `p. pause` | Pause current task |
|
|
75
|
+
| `p. resume` | Resume paused task |
|
|
76
|
+
| `p. linear` | Linear integration |
|
|
77
|
+
| `p. github` | GitHub Issues integration |
|
|
580
78
|
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
We get it! But consider:
|
|
584
|
-
|
|
585
|
-
- **No extra setup** - Works with whatever Claude subscription you have (free tier or Pro)
|
|
586
|
-
- **Better AI** - Latest Claude 3.5 Sonnet (Cursor/Windsurf use older models)
|
|
587
|
-
- **prjct-cli features** - Designed specifically for Claude's capabilities
|
|
588
|
-
|
|
589
|
-
Give Claude Code a try - you might prefer it! And if not, you can stay on v0.4.10 (last multi-editor version), though we don't recommend it.
|
|
590
|
-
|
|
591
|
-
**"This feels limiting"**
|
|
592
|
-
|
|
593
|
-
It's actually the opposite. By specializing, we can:
|
|
594
|
-
|
|
595
|
-
- Build features impossible with multi-platform (agents, MCP, git validation)
|
|
596
|
-
- Ship updates 2x faster (less code to maintain)
|
|
597
|
-
- Deliver higher quality (proper testing of everything we support)
|
|
598
|
-
|
|
599
|
-
**"What about my team?"**
|
|
600
|
-
|
|
601
|
-
prjct-cli is designed for **creators and small teams** (1-5 people) who ship fast.
|
|
602
|
-
|
|
603
|
-
For best results, standardize your team on Claude Code. Consistent tools = better collaboration. Works with whatever Claude subscription each team member has.
|
|
604
|
-
|
|
605
|
-
**"Is this a money grab?"**
|
|
606
|
-
|
|
607
|
-
**No.** There's zero financial incentive. prjct-cli works with whatever Claude subscription you have (free tier or Pro) - no extra costs, no tokens to buy, no API keys to configure.
|
|
608
|
-
|
|
609
|
-
This decision is purely **technical** - to build the best possible tool for developers who ship fast by leveraging Claude's unique capabilities.
|
|
610
|
-
|
|
611
|
-
**"Will you add back multi-editor support?"**
|
|
612
|
-
|
|
613
|
-
**No.** This was a deliberate architectural decision for v0.5.0, not a temporary change.
|
|
614
|
-
|
|
615
|
-
However, **v0.4.10 still exists** if you need multi-editor support. You can lock to that version with:
|
|
79
|
+
## CLI Commands
|
|
616
80
|
|
|
617
81
|
```bash
|
|
618
|
-
|
|
82
|
+
prjct start # First-time setup (Claude/Gemini)
|
|
83
|
+
prjct init # Initialize project (+ Cursor setup)
|
|
84
|
+
prjct --version # Show version + provider status
|
|
85
|
+
prjct --help # Show help
|
|
619
86
|
```
|
|
620
87
|
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
### Can I work on multiple tasks?
|
|
624
|
-
|
|
625
|
-
No, by design. Single-focus philosophy. Use `/p:done` before switching.
|
|
626
|
-
|
|
627
|
-
### Difference between `/p:done` and `/p:ship`?
|
|
628
|
-
|
|
629
|
-
`/p:done` clears focus. `/p:ship` celebrates important features with metrics.
|
|
630
|
-
|
|
631
|
-
### Where is my data stored?
|
|
632
|
-
|
|
633
|
-
Everything is local in `~/.prjct-cli/projects/{id}/`. Never leaves your machine.
|
|
634
|
-
|
|
635
|
-
### Does it work with teams?
|
|
636
|
-
|
|
637
|
-
Designed for creators and small teams (2-5 people). Each member has their own local data in `~/.prjct-cli/projects/{id}/`, with shared `.prjct/prjct.config.json` in the repo for project identification.
|
|
638
|
-
|
|
639
|
-
### How do I migrate from Jira/Trello?
|
|
640
|
-
|
|
641
|
-
No migration needed. Just `/p:init` and start working.
|
|
642
|
-
|
|
643
|
-
> 💬 **More questions?** Check [MIGRATION.md](MIGRATION.md) or [open an issue](https://github.com/jlopezlira/prjct-cli/issues)
|
|
644
|
-
|
|
645
|
-
## 🤝 Contributing
|
|
88
|
+
## Requirements
|
|
646
89
|
|
|
647
|
-
|
|
90
|
+
- Node.js 18+ or Bun 1.0+
|
|
91
|
+
- One of: Claude Code, Gemini CLI, or Cursor IDE
|
|
648
92
|
|
|
649
|
-
##
|
|
93
|
+
## Links
|
|
650
94
|
|
|
651
|
-
|
|
95
|
+
- [Website](https://prjct.app)
|
|
96
|
+
- [GitHub](https://github.com/jlopezlira/prjct-cli)
|
|
97
|
+
- [npm](https://www.npmjs.com/package/prjct-cli)
|
|
652
98
|
|
|
653
|
-
|
|
99
|
+
## License
|
|
654
100
|
|
|
655
|
-
|
|
101
|
+
MIT
|