Skip to content

Commit 56e7026

Browse files
docs(user): name the SSH host requirements and the npx update path
Co-Authored-By: Claude Fable 5 <[email protected]>
1 parent b69cdf7 commit 56e7026

3 files changed

Lines changed: 16 additions & 12 deletions

File tree

‎docs/user/install.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@ irm https://t3.codes/install.ps1 | iex
2323
This puts `t3` in `~/.local/bin`. Set `T3CODE_CHANNEL=nightly` to install the
2424
nightly train, or `T3CODE_VERSION` to pin an exact version.
2525

26-
| Task | Command |
27-
| ------------------------------------- | --------------------------------------------------------- |
28-
| Start the server and open the web app | `t3` |
29-
| Start the server without a browser | `t3 serve` |
30-
| Keep it running in the background | `t3 service install` ([details](./background-service.md)) |
31-
| Move to the newest release | `t3 update` |
32-
| Remove it again | `t3 uninstall` |
26+
| Task | Command |
27+
| ------------------------------------------------ | --------------------------------------------------------- |
28+
| Start the server and open the web app | `t3` |
29+
| Start the server without a browser | `t3 serve` |
30+
| Keep it running in the background (macOS, Linux) | `t3 service install` ([details](./background-service.md)) |
31+
| Move to the newest release | `t3 update` |
32+
| Remove it again | `t3 uninstall` |
3333

3434
Run `t3 --help` for the full reference.
3535

‎docs/user/remote-access.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -125,9 +125,10 @@ In the desktop app, open **Settings → Connections → Add environment**, choos
125125
or reuses a server there and opens the port forward for you. Projects, provider
126126
credentials, and agent work stay on the remote machine.
127127

128-
The remote host needs `curl` or `wget`, `tar`, and
129-
[provider setup](./install.md#providers). The first launch downloads T3 Code's
130-
server to `~/.t3/runtime` on the host, so it takes longer than later ones.
128+
The remote host must be Linux or an Apple Silicon Mac with `curl` or `wget`,
129+
`tar`, `sha256sum` or `shasum`, and [provider setup](./install.md#providers).
130+
The first launch downloads T3 Code's server to `~/.t3/runtime` on the host, so
131+
it takes longer than later ones.
131132
Provider CLIs must be on the `PATH` of a non-interactive login shell there;
132133
check with:
133134

‎docs/user/updating.md‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,11 @@ Replace `<client-version>` with the version shown in the notice. The command
4141
asks before restarting the background service; if you decline, run
4242
`t3 service restart` when you are ready. For a server you started by hand,
4343
stop it and start it again afterwards with your usual options such as `--host`
44-
or `--tailscale-serve`. If you run the server with `npx`, the copied command is
45-
`npx t3@<client-version>`.
44+
or `--tailscale-serve`.
45+
46+
If you run the server with `npx` rather than an installed `t3`, there is
47+
nothing to update on the host: stop the server and relaunch it as
48+
`npx t3@<client-version>` with the same subcommand and options.
4649

4750
## If an update fails
4851

0 commit comments

Comments
 (0)