codebyplan 0.0.1 → 1.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 +51 -11
- package/dist/cli.js +2649 -0
- package/package.json +29 -7
- package/index.js +0 -17
package/README.md
CHANGED
|
@@ -2,21 +2,61 @@
|
|
|
2
2
|
|
|
3
3
|
CLI for [CodeByPlan](https://codebyplan.com) — AI-powered development planning and tracking.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## Installation
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
```bash
|
|
8
|
+
npx codebyplan setup
|
|
9
|
+
```
|
|
8
10
|
|
|
9
|
-
|
|
11
|
+
This will:
|
|
12
|
+
1. Prompt for your API key (get one at [codebyplan.com/settings/api-keys](https://codebyplan.com/settings/api-keys))
|
|
13
|
+
2. Configure Claude Code to connect via remote MCP
|
|
14
|
+
3. Optionally link a repository and run the first sync
|
|
10
15
|
|
|
11
|
-
|
|
16
|
+
## Commands
|
|
12
17
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
18
|
+
### `codebyplan setup`
|
|
19
|
+
|
|
20
|
+
Interactive setup wizard. Configures your API key and MCP server connection.
|
|
21
|
+
|
|
22
|
+
### `codebyplan sync`
|
|
23
|
+
|
|
24
|
+
Bidirectional sync of `.claude/` infrastructure files between your local project and the CodeByPlan database.
|
|
25
|
+
|
|
26
|
+
**Options:**
|
|
17
27
|
|
|
18
|
-
|
|
28
|
+
| Flag | Description |
|
|
29
|
+
|------|-------------|
|
|
30
|
+
| `--path <dir>` | Project root directory (default: cwd) |
|
|
31
|
+
| `--repo-id <uuid>` | Repository ID (default: from `.codebyplan.json`) |
|
|
32
|
+
| `--dry-run` | Preview changes without writing |
|
|
33
|
+
| `--force` | Skip confirmation and conflict prompts |
|
|
34
|
+
| `--fix` | Auto-create missing port allocations |
|
|
35
|
+
|
|
36
|
+
### `codebyplan help`
|
|
37
|
+
|
|
38
|
+
Show help message.
|
|
39
|
+
|
|
40
|
+
### `codebyplan --version`
|
|
41
|
+
|
|
42
|
+
Print the CLI version.
|
|
43
|
+
|
|
44
|
+
## MCP Server
|
|
45
|
+
|
|
46
|
+
Claude Code connects to CodeByPlan via a remote MCP server. The `setup` command configures this automatically:
|
|
47
|
+
|
|
48
|
+
```json
|
|
49
|
+
{
|
|
50
|
+
"mcpServers": {
|
|
51
|
+
"codebyplan": {
|
|
52
|
+
"url": "https://codebyplan.com/mcp",
|
|
53
|
+
"headers": { "x-api-key": "your-api-key" }
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
```
|
|
19
58
|
|
|
20
|
-
|
|
59
|
+
## Learn More
|
|
21
60
|
|
|
22
|
-
|
|
61
|
+
- [codebyplan.com](https://codebyplan.com)
|
|
62
|
+
- [API Keys](https://codebyplan.com/settings/api-keys)
|