Getting started

Installation

The shortest path is the install script:

curl -fsSL https://sudoterm.com/install | bash

It detects your distribution (Ubuntu, Debian, Fedora, Arch, Alpine), installs the required packages (tmux, curl, tar, Node.js 22 if missing), downloads the sudoterm release tarball, sets up cloudflared, registers a subdomain, installs the systemd unit, and starts the daemon.

Flags

curl -fsSL https://sudoterm.com/install | bash -s -- \
  --subdomain my-vps \
  --no-interactive

Flag	Purpose
`--subdomain <name>`	Pre-fill the subdomain prompt
`--no-interactive`	Don't prompt — fail if required info missing
`--dry-run`	Print actions without changing anything
`--version <tag>`	Pin a specific release
`--registry <url>`	Override the registry endpoint (dev only)
`--skip-cloudflared`	Don't install cloudflared (assumes pre-installed)
`--skip-systemd`	Don't install a systemd unit (run daemon manually)

Manual install

If you'd rather not pipe a script:

# 1. Install prerequisites
sudo apt-get install -y tmux curl tar nodejs

# 2. Download the release tarball
curl -fsSL https://github.com/sudoterm/sudoterm/releases/latest/download/sudoterm-linux-amd64.tar.gz -o /tmp/sudoterm.tar.gz

# 3. Extract
sudo mkdir -p /opt/sudoterm
sudo tar -xzf /tmp/sudoterm.tar.gz -C /opt/sudoterm --strip-components=1

# 4. Link the CLI
sudo ln -sf /opt/sudoterm/bin/sudoterm /usr/local/bin/sudoterm

# 5. Register a subdomain
sudoterm subdomain change my-vps

# 6. Install the systemd unit and start
sudo install -m 644 /opt/sudoterm/assets/sudoterm.service /etc/systemd/system/
sudo systemctl daemon-reload
sudo systemctl enable --now sudoterm

Verify

sudoterm status
sudoterm doctor

The status banner prints your public URL. Open it in a browser to finish setup (password + AI key).

Configuration →