planmode 0.1.4 → 0.2.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 +72 -0
- package/dist/index.js +1183 -193
- package/dist/mcp.d.ts +2 -0
- package/dist/mcp.js +2435 -0
- package/package.json +6 -3
- package/src/commands/doctor.ts +43 -0
- package/src/commands/init.ts +17 -36
- package/src/commands/mcp.ts +39 -0
- package/src/commands/publish.ts +3 -191
- package/src/commands/record.ts +76 -0
- package/src/commands/snapshot.ts +46 -0
- package/src/commands/test.ts +45 -0
- package/src/index.ts +11 -1
- package/src/lib/doctor.ts +123 -0
- package/src/lib/init.ts +71 -0
- package/src/lib/installer.ts +20 -1
- package/src/lib/logger.ts +74 -11
- package/src/lib/publisher.ts +203 -0
- package/src/lib/recorder.ts +195 -0
- package/src/lib/snapshot.ts +348 -0
- package/src/lib/templates.ts +60 -0
- package/src/lib/tester.ts +162 -0
- package/src/mcp.ts +853 -0
- package/src/types/index.ts +2 -0
- package/tsup.config.ts +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
# planmode
|
|
2
|
+
|
|
3
|
+
The open source package manager for AI plans, rules, and prompts.
|
|
4
|
+
|
|
5
|
+
**Website:** [planmode.org](https://planmode.org)
|
|
6
|
+
**Repository:** [github.com/kaihannonen/planmode.org](https://github.com/kaihannonen/planmode.org)
|
|
7
|
+
|
|
8
|
+
## Install
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
npm install -g planmode
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
## Quick start
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
# Search for packages
|
|
18
|
+
planmode search nextjs
|
|
19
|
+
|
|
20
|
+
# Install a plan (adds to plans/ and updates CLAUDE.md)
|
|
21
|
+
planmode install nextjs-tailwind-starter
|
|
22
|
+
|
|
23
|
+
# Install a rule (goes to .claude/rules/)
|
|
24
|
+
planmode install typescript-strict
|
|
25
|
+
|
|
26
|
+
# Run a templated prompt
|
|
27
|
+
planmode run rest-api-generator --resource users --framework express
|
|
28
|
+
|
|
29
|
+
# See what's installed
|
|
30
|
+
planmode list
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Package types
|
|
34
|
+
|
|
35
|
+
| Type | What it is | Where it lives | Lifecycle |
|
|
36
|
+
|------|-----------|---------------|-----------|
|
|
37
|
+
| **Plan** | Multi-step implementation guide | `plans/*.md` | Active during task |
|
|
38
|
+
| **Rule** | Always-on constraint | `.claude/rules/*.md` | Permanent |
|
|
39
|
+
| **Prompt** | Fire-once instruction | `prompts/*.md` | Single use |
|
|
40
|
+
|
|
41
|
+
## Commands
|
|
42
|
+
|
|
43
|
+
| Command | Description |
|
|
44
|
+
|---------|-------------|
|
|
45
|
+
| `planmode install <pkg>` | Install a package |
|
|
46
|
+
| `planmode uninstall <pkg>` | Remove a package |
|
|
47
|
+
| `planmode search <query>` | Search the registry |
|
|
48
|
+
| `planmode run <prompt>` | Run a templated prompt |
|
|
49
|
+
| `planmode list` | List installed packages |
|
|
50
|
+
| `planmode info <pkg>` | Show package details |
|
|
51
|
+
| `planmode update [pkg]` | Update packages |
|
|
52
|
+
| `planmode init` | Create a new package |
|
|
53
|
+
| `planmode publish` | Publish to the registry |
|
|
54
|
+
| `planmode login` | Configure GitHub auth |
|
|
55
|
+
|
|
56
|
+
## How it works
|
|
57
|
+
|
|
58
|
+
Planmode leverages Claude Code's native `@import` system. When you install a plan:
|
|
59
|
+
|
|
60
|
+
1. The CLI fetches `.md` files from the registry
|
|
61
|
+
2. Drops them into the correct directory (`plans/`, `.claude/rules/`, or `prompts/`)
|
|
62
|
+
3. Adds `@plans/<name>.md` to your `CLAUDE.md`
|
|
63
|
+
|
|
64
|
+
Claude Code is already the runtime. Planmode handles discovery, versioning, and distribution.
|
|
65
|
+
|
|
66
|
+
## Browse packages
|
|
67
|
+
|
|
68
|
+
Visit [planmode.org/packages](https://planmode.org/packages) to discover plans, rules, and prompts.
|
|
69
|
+
|
|
70
|
+
## License
|
|
71
|
+
|
|
72
|
+
MIT
|