mirror of
https://github.com/l0ng-ai/tty7.git
synced 2026-10-01 00:01:54 +00:00
l0ng-ai
f5a97ed68c
A portable ZIP install whose folder has both the .tty7-portable marker and a data\ folder next to tty7-app.exe now uses <exe dir>\data as its config directory, so settings, sessions, scrollback and the daemon's socket travel with the program. --config-dir and TTY7_CONFIG_DIR still win. The folder is an explicit opt-in because the marker has shipped in every portable ZIP since the in-app updater arrived: keying on it alone would move existing users onto an empty directory at their next update. The portable directory is not the machine's config dir, so a portable copy never adopts the installed tty7's legacy tree. An updater test pins that data\ is not a managed root and survives an in-place update.
178 lines
6.5 KiB
Plaintext
178 lines
6.5 KiB
Plaintext
---
|
||
title: "Installation"
|
||
description: "Native builds for macOS, Windows, and Linux — plus building from source."
|
||
---
|
||
|
||
Every release publishes native builds on
|
||
[**GitHub Releases**](https://github.com/l0ng-ai/tty7/releases). There is no
|
||
runtime to install first: fonts are embedded in the binary, and the Linux
|
||
AppImage bundles its own X11/Wayland/font libraries.
|
||
|
||
<Tabs>
|
||
<Tab title="macOS">
|
||
Download the DMG that matches your Mac and drag **tty7** into Applications.
|
||
|
||
| Mac | File |
|
||
|---|---|
|
||
| Apple silicon (M1 and later) | `tty7-<version>-macos-arm64.dmg` |
|
||
| Intel | `tty7-<version>-macos-x86_64.dmg` |
|
||
|
||
Builds are signed with a Developer ID certificate and notarized by Apple, so
|
||
Gatekeeper opens them without a right-click dance.
|
||
|
||
<Note>
|
||
Builds are produced on macOS 14 and macOS 15. macOS 14 (Sonoma) or later
|
||
is the tested range.
|
||
</Note>
|
||
</Tab>
|
||
|
||
<Tab title="Windows">
|
||
Two shapes, both x86-64:
|
||
|
||
| File | Use it when |
|
||
|---|---|
|
||
| `tty7-<version>-windows-x86_64-setup.exe` | You want a normal install with Start-menu entries and an uninstaller. |
|
||
| `tty7-<version>-windows-x86_64.zip` | You want it portable — unzip anywhere and run `tty7-app.exe`. |
|
||
|
||
The installer offers one optional setup task, off by default: **Add "Open in
|
||
tty7" to the folder context menu**. It writes shell verbs under `HKCU`, so
|
||
only your own Windows account is affected, and the uninstaller always takes
|
||
them back out.
|
||
|
||
A portable install can add or remove the same entries itself:
|
||
|
||
```powershell
|
||
tty7-app.exe --register-explorer-menu
|
||
tty7-app.exe --unregister-explorer-menu
|
||
```
|
||
|
||
**Portable mode.** Out of the box the ZIP keeps settings, sessions and
|
||
scrollback in `%APPDATA%\tty7`, like the installer. To keep them beside the
|
||
program instead — on a USB stick, or a machine you do not want to leave
|
||
traces on — create an empty folder named `data` next to `tty7-app.exe`:
|
||
|
||
```text
|
||
tty7\
|
||
tty7-app.exe
|
||
tty7.exe
|
||
.tty7-portable
|
||
data\ <- everything tty7 writes goes here
|
||
```
|
||
|
||
tty7 uses it from the next launch on; quit tty7 first (**Quit and Stop
|
||
Server** from the tray menu) so the background server restarts there too.
|
||
To bring your existing setup along, copy the contents of `%APPDATA%\tty7`
|
||
into `data`. In-app updates replace only the files the ZIP ships, so `data`
|
||
survives them. The `tty7` command in the same folder finds the same data, and
|
||
`TTY7_CONFIG_DIR` or `--config-dir` still override it — see
|
||
[config.json](/reference/configuration#where-the-directory-comes-from).
|
||
|
||
Nothing has to be installed first. The executables link the Visual C++
|
||
runtime statically, so the "Visual C++ 2015–2022 Redistributable" is not a
|
||
prerequisite — releases up to and including 26.9.2 did need it, and failed
|
||
to start at all on a machine that had never installed it.
|
||
|
||
<Note>
|
||
The Windows package also carries a Linux `tty7-server` binary so a WSL
|
||
distro can be served locally instead of downloading one. See
|
||
[Remote workspaces](/remote/workspaces).
|
||
</Note>
|
||
</Tab>
|
||
|
||
<Tab title="Linux">
|
||
| File | Use it when |
|
||
|---|---|
|
||
| `tty7-<version>-linux-x86_64.AppImage` | Almost always. `chmod +x` and run — the X11, Wayland, xkb, and font libraries are bundled, so it works on Fedora, Arch, Debian and friends, not just Ubuntu. |
|
||
| `tty7-<version>-linux-x86_64.tar.gz` | You would rather unpack the plain binary and place it yourself. |
|
||
|
||
```bash
|
||
chmod +x tty7-*-linux-x86_64.AppImage
|
||
./tty7-*-linux-x86_64.AppImage
|
||
```
|
||
</Tab>
|
||
</Tabs>
|
||
|
||
## The `tty7` command
|
||
|
||
Every installer ships the `tty7` CLI beside the app, and the app puts it on your
|
||
PATH the first time it launches. That is what lets a script — or a coding agent
|
||
in some other terminal — open panes and read them back.
|
||
|
||
- **On Unix** it is a symlink into whichever of `/opt/homebrew/bin`,
|
||
`/usr/local/bin`, `~/.local/bin`, `~/bin`, or `~/.cargo/bin` your PATH already
|
||
covers.
|
||
- **On Windows** the install directory is appended to your user PATH, and the
|
||
uninstaller removes it again.
|
||
|
||
A `tty7` you installed yourself — a `cargo install` build, a package manager's
|
||
copy — is never replaced. To turn the whole thing off, uncheck **Settings → Integrations → Install the tty7 command on PATH**.
|
||
|
||
<Tip>
|
||
Inside a tty7 pane the CLI works regardless of PATH, because panes inherit the
|
||
app's environment.
|
||
</Tip>
|
||
|
||
## Updating
|
||
|
||
tty7 checks for updates every six hours and can update itself: **Settings →
|
||
About → Check now**, then **Update and relaunch**. Releases are downloaded and
|
||
verified in the background so applying one is just a restart.
|
||
|
||
Pick **Stable** or **Nightly** under **Settings → General → Updates → Update channel**. See
|
||
[Updates and channels](/reference/updates) for what each feed publishes and how
|
||
switching behaves.
|
||
|
||
## Building from source
|
||
|
||
You need a stable Rust toolchain. The build is a plain `cargo build`; the app
|
||
binary is `tty7-app`.
|
||
|
||
<Tabs>
|
||
<Tab title="macOS / Windows">
|
||
```bash
|
||
git clone https://github.com/l0ng-ai/tty7
|
||
cd tty7
|
||
cargo build --release
|
||
```
|
||
</Tab>
|
||
<Tab title="Linux">
|
||
gpui resolves its X11/Wayland/font backends through `pkg-config` at build
|
||
time, so the development packages have to be present:
|
||
|
||
```bash
|
||
sudo apt-get install -y pkg-config cmake clang \
|
||
libxkbcommon-dev libxkbcommon-x11-dev \
|
||
libfontconfig1-dev libfreetype6-dev \
|
||
libwayland-dev libx11-dev libxcb1-dev \
|
||
libzstd-dev libssl-dev libkrb5-dev
|
||
cargo build --release
|
||
```
|
||
</Tab>
|
||
</Tabs>
|
||
|
||
<Warning>
|
||
A source build does not update itself, and it will not replace an installed
|
||
copy's server. If you run both, see
|
||
[Troubleshooting](/reference/troubleshooting).
|
||
</Warning>
|
||
|
||
## Uninstalling
|
||
|
||
<AccordionGroup>
|
||
<Accordion title="macOS">
|
||
Quit tty7 (use **Quit and Stop Server** from the tray menu so the background
|
||
server stops too), then drag the app to the Trash. Your settings live in
|
||
`~/.config/tty7` and are left alone; delete that folder to remove them.
|
||
</Accordion>
|
||
<Accordion title="Windows">
|
||
Use **Add or remove programs**. The uninstaller removes the PATH entry and
|
||
any Explorer context-menu keys it added. Settings live in
|
||
`%APPDATA%\tty7`. For the ZIP, delete the unzipped folder — in portable mode
|
||
its `data` folder is all there is.
|
||
</Accordion>
|
||
<Accordion title="Linux">
|
||
Delete the AppImage or the unpacked directory. Settings live in
|
||
`~/.config/tty7`.
|
||
</Accordion>
|
||
</AccordionGroup>
|