Skip to main content

A cross-platform desktop terminal with workspaces and tabs

Project description

terminux

A fast, reliable, cross-platform terminal, organized the way you actually work.

Workspaces on the left. Tabbed terminals in the middle. Everything where you left it.

Python Platform Status License


terminux — workspaces sidebar and a tabbed terminal running a test suite

Why terminux?

You don't have one project. You have six. Each one is a different directory, a different mental context, a different set of running shells. terminux gives each of them a home (a workspace) and keeps them alive and arranged exactly how you left them, even across restarts.

It's the workspace UX of cmux on a clean, auditable two-process architecture inspired by terax. Rebuilt in Python for reliability over features. No accounts. No telemetry. No AI. Just a terminal that respects your flow.

uv sync && make frontend
uv run terminux

That's it. You're in.

✨ What you get

  • Workspaces sidebar: a persistent list of named workspaces. Names track the first tab's working directory automatically (until you pin one).
  • Tabbed terminals: every workspace has its own tabs, each a real PTY shell. Switch freely; background tabs keep streaming, no jank.
  • Survives restarts: workspaces, tabs, window geometry, font size, each shell's working directory, and the visible scrollback of every tab all come back. Fresh shells, same layout, same view you left.
  • Remote access: run the backend on a server, connect from your laptop with --connect. Shells and long-running builds survive lid-closes, network hops, and device switches. See Remote access.
  • Keyboard-first: sidebar shows a keycap on each of the first nine workspaces; jump straight there with Ctrl+Shift+1..9 on Linux (Cmd+1..9 on macOS). Plus a fuzzy quick-switcher, find-in-terminal, font zoom, and more.
  • Platform-respecting shortcuts: Linux uses Ctrl+Shift+<key> for app shortcuts (matching GNOME Terminal, Konsole, Alacritty, Ghostty, kitty), so raw Ctrl+P / Ctrl+B / Ctrl+F flow straight to your shell. macOS uses Cmd for the same job; raw Ctrl is left alone.
  • Clickable URLs & iTerm2-style copy: modifier-click opens links; optional auto-copy on selection, persisted, off by default.
  • Working vs ready: a two-color sidebar dot reads like a CI traffic light — amber while a foreground task is actively working (idle TUIs and parked prompts don't count), green once it finishes. Works out of the box; opt-in shell integration makes it more precise. Plain output by itself never falsely promotes to green.
  • Drag & drop: reorder workspaces and tabs with live drop feedback. Drop a file to paste its shell-quoted path.
  • Local-first & hardened: loopback-only by default, per-session auth token, CSP and security headers, atomic versioned persistence.
The fuzzy quick switcher (Ctrl+Shift+P / Cmd+P) jumping between workspaces and tabs

The fuzzy quick switcher (Ctrl+Shift+P on Linux, Cmd+P on macOS): jump to any workspace or tab.

Run

uv sync
make frontend                # build the web UI (needs Node; first run only)
uv run terminux              # desktop window (pywebview)
uv run terminux --no-window  # server only; open the printed URL in a browser
uv run terminux --debug      # verbose logs + slow-op warnings
uv run terminux --trace      # extreme: log every save/load/cwd lookup

--no-window serves the same UI to any browser — handy for development and for running terminux where no display is available. --debug and --trace are diagnostics flags; see Debugging knobs.

Remote mode

Run terminux on a headless server and connect from your laptop:

# on the server
uv run terminux --server --port 8443
# prints: terminux server listening — connect with:
#           http://127.0.0.1:8443/?t=abc-def-ghi

# on the laptop (one shell)
ssh -L 8443:localhost:8443 server.example.com

# on the laptop (another shell)
uv run terminux --connect http://localhost:8443/?t=abc-def-ghi

Shells, workspaces, and scrollback live on the server: disconnect, sleep the laptop, reconnect later, everything's where you left it. See Remote access for the full recipe (multi-client, firewall guidance, systemd service).

Install / package

terminux ships as a self-contained desktop app; no Python or Node required to run the bundle.

make build-linux  # Linux bundle (built in Docker) → dist/linux/terminux/terminux
make docker-run   # run headless web mode on :8000
make build-macos  # macOS .app → dist/terminux.app

Full platform notes (signing, Gatekeeper, X11, architectures) live in the documentation.

Documentation

Docs are built with Zensical and live in docs/.

make docs-serve    # live preview at http://127.0.0.1:8000
make docs          # static site → site/

Start with docs/index.md. The original vision, functional spec, and technical spec are in notes/.

Develop

make frontend        # build TS/Vite UI → src/terminux/web/static
make frontend-dev    # live Vite dev server against a --no-window backend
make frontend-test   # vitest unit tests (pure TS logic)
make test            # pytest: unit, integration, e2e (Playwright)
make lint            # ruff + ty + pyrefly + mypy
make format

The e2e tier drives the served UI with a real browser (no pywebview); install it once with uv run playwright install chromium.

Status: 0.7 preview

Works today: workspaces sidebar (create / rename / reorder / close, working/ready dot), tabs with multiple live terminals, real PTY shells streaming in the background, layout and scrollback restored across restarts (always with fresh shells), remote mode (--server / --connect), self-diagnosing freeze watchdog, macOS & Linux bundles.

Not yet: split panes, Windows PTY, multi-user.

Architecture in one breath

A Vite/TypeScript xterm.js web UI runs in a sandboxed pywebview window and talks to a loopback Starlette/uvicorn backend that owns the PTYs and streams raw bytes over per-terminal WebSockets. The frontend build output is committed to src/terminux/web/static/, so the Python package runs with no Node toolchain.

Built for people who keep too many terminals open. abilian/terminux

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

terminux-0.7.2.tar.gz (356.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

terminux-0.7.2-py3-none-any.whl (362.8 kB view details)

Uploaded Python 3

File details

Details for the file terminux-0.7.2.tar.gz.

File metadata

  • Download URL: terminux-0.7.2.tar.gz
  • Upload date:
  • Size: 356.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.33 {"installer":{"name":"uv","version":"0.11.33","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for terminux-0.7.2.tar.gz
Algorithm Hash digest
SHA256 4a706b82a28a78ee2023898141cdf2c7c8b82e60e38388e5e3cdebc89083be73
MD5 6c75703577ba6d9c0b7b606c581d48b2
BLAKE2b-256 4470926d7c0d73ecbe319b78dc041d94297f2254c3f21ab42541ae3f30407af6

See more details on using hashes here.

File details

Details for the file terminux-0.7.2-py3-none-any.whl.

File metadata

  • Download URL: terminux-0.7.2-py3-none-any.whl
  • Upload date:
  • Size: 362.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.33 {"installer":{"name":"uv","version":"0.11.33","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for terminux-0.7.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ddc6ee4236f293cd6b63e2bf82056907548df30915348538b9cb096291aeb0b6
MD5 7644fb6c5f68aad960912114a04a1393
BLAKE2b-256 e32f55b62ac48c7b84614ede61b54e9e1361fe9baf19aee01fdbf994adad6bfc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page