@codebyplan/cli 2.0.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 +114 -0
- package/dist/cli.js +23907 -0
- package/package.json +56 -0
package/README.md
ADDED
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
# @codebyplan/cli
|
|
2
|
+
|
|
3
|
+
MCP server for [CodeByPlan](https://codebyplan.com) — AI-powered development planning and tracking.
|
|
4
|
+
|
|
5
|
+
Connects Claude Code to your CodeByPlan workspace, giving Claude access to your checkpoints, tasks, launches, session logs, and more.
|
|
6
|
+
|
|
7
|
+
## Quickstart
|
|
8
|
+
|
|
9
|
+
1. **Sign up** at [codebyplan.com](https://codebyplan.com)
|
|
10
|
+
2. **Create an API key** at [Settings → API Keys](https://codebyplan.com/settings/api-keys/)
|
|
11
|
+
3. **Run setup:**
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npx -y @codebyplan/cli setup
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
The setup wizard validates your key and configures Claude Code automatically.
|
|
18
|
+
|
|
19
|
+
## Manual Setup
|
|
20
|
+
|
|
21
|
+
If you prefer to configure manually:
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
claude mcp add codebyplan -e CODEBYPLAN_API_KEY=your_key_here -- npx -y @codebyplan/cli
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Available Tools
|
|
28
|
+
|
|
29
|
+
### Read Tools (9)
|
|
30
|
+
|
|
31
|
+
| Tool | Description |
|
|
32
|
+
|------|-------------|
|
|
33
|
+
| `get_repos` | List repositories |
|
|
34
|
+
| `get_work_plan` | Get work plan for a repo/week/year |
|
|
35
|
+
| `get_checkpoints` | List checkpoints for a repo |
|
|
36
|
+
| `get_tasks` | List tasks for a checkpoint |
|
|
37
|
+
| `get_current_task` | Get the active in-progress task |
|
|
38
|
+
| `get_launches` | List launches for a repo |
|
|
39
|
+
| `get_launch` | Get a single launch |
|
|
40
|
+
| `get_session_logs` | List session logs for a repo |
|
|
41
|
+
| `get_session_log` | Get a single session log |
|
|
42
|
+
|
|
43
|
+
### Write Tools (16)
|
|
44
|
+
|
|
45
|
+
| Tool | Description |
|
|
46
|
+
|------|-------------|
|
|
47
|
+
| `create_repo` | Create a new repository |
|
|
48
|
+
| `create_checkpoint` | Create a new checkpoint |
|
|
49
|
+
| `update_checkpoint` | Update checkpoint details |
|
|
50
|
+
| `complete_checkpoint` | Mark a checkpoint as completed |
|
|
51
|
+
| `create_task` | Create a new task |
|
|
52
|
+
| `complete_task` | Mark a task as completed |
|
|
53
|
+
| `add_round` | Add a round to a task |
|
|
54
|
+
| `create_launch` | Create a new launch |
|
|
55
|
+
| `update_launch` | Update a launch |
|
|
56
|
+
| `delete_launch` | Delete a launch |
|
|
57
|
+
| `create_session_log` | Create a session log |
|
|
58
|
+
| `update_session_log` | Update a session log |
|
|
59
|
+
| `delete_session_log` | Delete a session log |
|
|
60
|
+
| `sync_claude_files` | Sync .claude/ infrastructure from the database |
|
|
61
|
+
|
|
62
|
+
### File Generation Tools (1)
|
|
63
|
+
|
|
64
|
+
| Tool | Description |
|
|
65
|
+
|------|-------------|
|
|
66
|
+
| `git_commit` | Stage and commit files in a repo |
|
|
67
|
+
|
|
68
|
+
### Diagnostic Tools (1)
|
|
69
|
+
|
|
70
|
+
| Tool | Description |
|
|
71
|
+
|------|-------------|
|
|
72
|
+
| `health_check` | Check server version, API connectivity, and latency |
|
|
73
|
+
|
|
74
|
+
## Environment Variables
|
|
75
|
+
|
|
76
|
+
| Variable | Required | Description |
|
|
77
|
+
|----------|----------|-------------|
|
|
78
|
+
| `CODEBYPLAN_API_KEY` | Yes | Your CodeByPlan API key |
|
|
79
|
+
| `CODEBYPLAN_API_URL` | No | API base URL (default: `https://codebyplan.com`) |
|
|
80
|
+
|
|
81
|
+
## CLI Commands
|
|
82
|
+
|
|
83
|
+
```bash
|
|
84
|
+
npx @codebyplan/cli # Start MCP server (used by Claude Code)
|
|
85
|
+
npx @codebyplan/cli setup # Interactive setup wizard
|
|
86
|
+
npx @codebyplan/cli --version # Print version
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
## Troubleshooting
|
|
90
|
+
|
|
91
|
+
### "Missing CODEBYPLAN_API_KEY"
|
|
92
|
+
|
|
93
|
+
Your API key is not set. Run `npx @codebyplan/cli setup` or set the environment variable manually when adding the MCP server.
|
|
94
|
+
|
|
95
|
+
### "Invalid API key"
|
|
96
|
+
|
|
97
|
+
Your API key is invalid or has been revoked. Generate a new one at [Settings → API Keys](https://codebyplan.com/settings/api-keys/).
|
|
98
|
+
|
|
99
|
+
### Connection timeouts
|
|
100
|
+
|
|
101
|
+
The server uses a 30-second timeout with automatic retries (3 attempts with exponential backoff) for transient errors. If you're behind a restrictive firewall, ensure `codebyplan.com` is accessible.
|
|
102
|
+
|
|
103
|
+
### Server not appearing in Claude Code
|
|
104
|
+
|
|
105
|
+
After running setup, start a **new** Claude Code session. The MCP server is loaded when a session begins.
|
|
106
|
+
|
|
107
|
+
## Requirements
|
|
108
|
+
|
|
109
|
+
- Node.js 18 or later
|
|
110
|
+
- A [CodeByPlan](https://codebyplan.com) account with an API key
|
|
111
|
+
|
|
112
|
+
## License
|
|
113
|
+
|
|
114
|
+
MIT
|