You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+28-4Lines changed: 28 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,18 +2,42 @@
2
2
3
3
T3 Code is a minimal web GUI for coding agents (currently Codex and Claude, more coming soon).
4
4
5
-
## How to use
5
+
## Installation
6
6
7
7
> [!WARNING]
8
-
> You need to have [Codex CLI](https://github.com/openai/codex) installed and authorized for T3 Code to work.
8
+
> T3 Code currently supports Codex and Claude.
9
+
> Install and authenticate at least one provider before use:
10
+
>
11
+
> - Codex: install [Codex CLI](https://github.com/openai/codex) and run `codex login`
12
+
> - Claude: install Claude Code and run `claude auth login`
13
+
14
+
### Run without installing
9
15
10
16
```bash
11
17
npx t3
12
18
```
13
19
14
-
You can also just install the desktop app. It's cooler.
20
+
### Desktop app
21
+
22
+
Install the latest version of the desktop app from [GitHub Releases](https://github.com/pingdotgg/t3code/releases), or from your favorite package registry:
23
+
24
+
#### Windows (`winget`)
25
+
26
+
```bash
27
+
winget install T3Tools.T3Code
28
+
```
29
+
30
+
#### macOS (Homebrew)
15
31
16
-
Install the [desktop app from the Releases page](https://github.com/pingdotgg/t3code/releases)
|`--auth-token <token>`|`T3CODE_AUTH_TOKEN`| WebSocket auth token. Use this for standard CLI and remote-server flows. |
18
+
|`--bootstrap-fd <fd>`|`T3CODE_BOOTSTRAP_FD`| Read a one-shot bootstrap envelope from an inherited file descriptor during startup. |
18
19
19
20
> TIP: Use the `--help` flag to see all available options and their descriptions.
20
21
21
22
## Security First
22
23
23
24
- Always set `--auth-token` before exposing the server outside localhost.
25
+
- When you control the process launcher, prefer sending the auth token in a JSON envelope via `--bootstrap-fd <fd>`.
26
+
With `--bootstrap-fd <fd>`, the launcher starts the server first, then sends a one-shot JSON envelope over the inherited file descriptor. This allows the auth token to be delivered without putting it in process environment or command line arguments.
24
27
- Treat the token like a password.
25
28
- Prefer binding to trusted interfaces (LAN IP or Tailnet IP) instead of opening all interfaces unless needed.
0 commit comments