@directed/cli 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 +81 -0
- package/dist/cli.js +1938 -0
- package/package.json +29 -0
package/README.md
ADDED
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
# directed
|
|
2
|
+
|
|
3
|
+
Run an interactive coding-agent CLI in a Directed chat. Teammates can follow
|
|
4
|
+
the transcript and steer the session by mentioning the agent in that chat.
|
|
5
|
+
|
|
6
|
+
```
|
|
7
|
+
directed claude [args...] # your normal claude, wrapped
|
|
8
|
+
directed codex [args...]
|
|
9
|
+
directed <anything> [args...]
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
The wrapped CLI remains native in your terminal. Codex and Claude Code sessions
|
|
13
|
+
stream their transcript and terminal playback into the chat, with every steer
|
|
14
|
+
attributed.
|
|
15
|
+
|
|
16
|
+
## Install
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
curl -fsSL https://hub.directed.ai/cli/install.sh | bash
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
or
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
npm install -g @directed/cli
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
Requires **tmux** (`brew install tmux`) and Node 20+. macOS/Linux.
|
|
29
|
+
|
|
30
|
+
## Sign in
|
|
31
|
+
|
|
32
|
+
Sessions are gated behind your Directed account. The first run opens your
|
|
33
|
+
browser to sign in; `directed login` / `directed logout` manage it explicitly.
|
|
34
|
+
|
|
35
|
+
## Help
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
directed --help
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
To see help for the wrapped command instead, put `--help` after its name, such
|
|
42
|
+
as `directed codex --help` or `directed claude --help`.
|
|
43
|
+
|
|
44
|
+
## Collaborate and steer
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
directed --with @jane claude
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
`--with` adds active connections to the session chat. A participant steers the
|
|
51
|
+
running agent by mentioning it there. By default the steer is submitted
|
|
52
|
+
immediately; `--accept-mode stage` places it on the terminal input line for you
|
|
53
|
+
to review first.
|
|
54
|
+
|
|
55
|
+
Sessions stream into a Directed chat by default. `--no-chat` keeps a session
|
|
56
|
+
fully local, and resuming a session (`--resume`, `-c`, `codex resume`) picks its
|
|
57
|
+
chat back up.
|
|
58
|
+
|
|
59
|
+
## Flags
|
|
60
|
+
|
|
61
|
+
| Flag | Meaning |
|
|
62
|
+
|---|---|
|
|
63
|
+
| `--accept-mode send\|stage` | steer messages submit immediately, or land staged on the input line |
|
|
64
|
+
| `--no-chat` / `--chat` | disable / force streaming to a Directed chat |
|
|
65
|
+
| `--into` / `--into=<URL or public id>` | choose from 10 recent chat titles and links, or stream into the exact chat given after `=` |
|
|
66
|
+
| `--with <people>` | add people to the session chat (`@username` or email, comma-separated; entries that aren't your active connections are skipped with a warning) |
|
|
67
|
+
| `--invite <emails>` | email a join link: opens a mail draft to these addresses with the chat's share link |
|
|
68
|
+
| `--no-open` | don't open the chat in your browser when the session starts |
|
|
69
|
+
| `--name <label>` | session label |
|
|
70
|
+
| `-h` / `--help` | show CLI usage and options |
|
|
71
|
+
|
|
72
|
+
## Updating
|
|
73
|
+
|
|
74
|
+
`directed` checks for updates once a day and prints a notice when one is
|
|
75
|
+
available. `directed upgrade` installs it.
|
|
76
|
+
|
|
77
|
+
## Security
|
|
78
|
+
|
|
79
|
+
- Only members of the Directed chat can send steering mentions.
|
|
80
|
+
- Steer messages are injected as literal text into `directed`'s own tmux
|
|
81
|
+
session, with no shell interpolation.
|