planbee 0.1.0 → 0.1.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 +50 -39
- package/bin/planbee.js +133 -133
- package/package.json +2 -6
package/README.md
CHANGED
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# PlanBee CLI
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
Claude
|
|
3
|
+
Command-line client for [PlanBee](https://planbee.cloud) — agent coordination,
|
|
4
|
+
Claude Code hooks and voice notifications.
|
|
5
5
|
|
|
6
|
-
|
|
7
|
-
|
|
6
|
+
This package is a client. It requires a PlanBee server (cloud or self-hosted)
|
|
7
|
+
and is not usable without access to one. Get started at
|
|
8
|
+
[planbee.cloud](https://planbee.cloud).
|
|
8
9
|
|
|
9
10
|
## Installation
|
|
10
11
|
|
|
@@ -13,64 +14,74 @@ npm install -g planbee
|
|
|
13
14
|
planbee --version
|
|
14
15
|
```
|
|
15
16
|
|
|
16
|
-
Node.js 18
|
|
17
|
+
Node.js 18 or newer.
|
|
17
18
|
|
|
18
|
-
##
|
|
19
|
+
## Updating
|
|
20
|
+
|
|
21
|
+
npm does not update global packages automatically. To upgrade to the latest
|
|
22
|
+
release:
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
npm install -g planbee@latest
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## Login
|
|
19
29
|
|
|
20
30
|
```bash
|
|
21
31
|
planbee auth login --email you@example.com
|
|
22
32
|
```
|
|
23
33
|
|
|
24
|
-
|
|
25
|
-
`~/.planbee/cli-auth.json`
|
|
26
|
-
|
|
34
|
+
This creates a long-lived CLI token (PAT) and stores it in
|
|
35
|
+
`~/.planbee/cli-auth.json` with `0600` permissions. Alternatively, an existing
|
|
36
|
+
token can be stored with `planbee auth login --token <token>`.
|
|
27
37
|
|
|
28
|
-
|
|
38
|
+
Against your own server:
|
|
29
39
|
|
|
30
40
|
```bash
|
|
31
|
-
planbee --local <
|
|
32
|
-
PLANBEE_API_URL=https://… planbee … #
|
|
41
|
+
planbee --local <command> # http://localhost:3456
|
|
42
|
+
PLANBEE_API_URL=https://… planbee … # any endpoint
|
|
33
43
|
```
|
|
34
44
|
|
|
35
|
-
##
|
|
45
|
+
## What is sent to the server
|
|
36
46
|
|
|
37
|
-
|
|
47
|
+
The client is not a read-only viewer. So you know what happens:
|
|
38
48
|
|
|
39
|
-
- **Session
|
|
40
|
-
|
|
41
|
-
- **Claude
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
- **
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
49
|
+
- **Session and task data:** topic, task list, progress, status and the state
|
|
50
|
+
objects you set yourself (`planbee progress`).
|
|
51
|
+
- **Claude Code transcripts:** once the hooks are installed, the client reads the
|
|
52
|
+
conversation files under `~/.claude/projects/<project>/<session>.jsonl`
|
|
53
|
+
incrementally and uploads the new lines to the server so the conversation is
|
|
54
|
+
visible in the dashboard. This includes **the complete history, including your
|
|
55
|
+
prompts and the model responses.**
|
|
56
|
+
- **Machine name:** when a CLI token is created, the hostname is sent as the
|
|
57
|
+
token label (`cli-<hostname>`) so you can tell tokens apart.
|
|
58
|
+
- **Messages** between agents and the text of voice notifications
|
|
59
|
+
(`planbee speak`).
|
|
50
60
|
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
61
|
+
Without installed hooks, no transcripts are transferred. Hooks are only set up
|
|
62
|
+
by `planbee hooks install`; the command writes to the `.claude/settings.json`
|
|
63
|
+
of the given project.
|
|
54
64
|
|
|
55
|
-
|
|
56
|
-
|
|
65
|
+
If you run your own server (`--local` / `PLANBEE_API_URL`), this data goes
|
|
66
|
+
there exclusively.
|
|
57
67
|
|
|
58
68
|
## Hooks
|
|
59
69
|
|
|
60
70
|
```bash
|
|
61
|
-
planbee hooks install --project /
|
|
71
|
+
planbee hooks install --project /path/to/project
|
|
62
72
|
planbee hooks status
|
|
63
73
|
```
|
|
64
74
|
|
|
65
|
-
##
|
|
75
|
+
## Author and support
|
|
66
76
|
|
|
67
|
-
|
|
77
|
+
[planbee.cloud](https://planbee.cloud) — infin8 world llc,
|
|
78
|
+
[www.infin8.world](https://www.infin8.world)
|
|
68
79
|
|
|
69
|
-
##
|
|
80
|
+
## License
|
|
70
81
|
|
|
71
|
-
|
|
72
|
-
|
|
82
|
+
Proprietary, see `LICENSE`: use as a client is permitted, resale and reuse of
|
|
83
|
+
the source code are not.
|
|
73
84
|
|
|
74
|
-
|
|
75
|
-
`THIRD-PARTY-NOTICES.txt` (44
|
|
76
|
-
`bin/planbee.js.LEGAL.txt`;
|
|
85
|
+
The license texts of the bundled open-source packages are included in full in
|
|
86
|
+
`THIRD-PARTY-NOTICES.txt` (44 packages, MIT/ISC) and in
|
|
87
|
+
`bin/planbee.js.LEGAL.txt`; for those components they take precedence.
|