Skip to main content
The Terma CLI (terma) is a single static binary with no runtime dependency. Install it, then run terma setup.

​
Install the CLI

Every method installs the same release and verifies it against the release’s checksums.txt. We recommend the install script: it is the only installation that can update itself automatically.
Homebrew does not update terma automatically, and neither does npm. When terma is owned by a package manager, it only tells you when a new release is out. Run terma update (or brew upgrade terma) to install it. See Homebrew and npm installs.

​
Install script options

The install script is POSIX sh, so | sh works too. It picks the archive for your platform, verifies the checksum, and places the binary in ~/.local/bin. It never asks for sudo. If ~/.local/bin is not on your PATH yet, the script prints the line that adds it.

​
Direct download or source

Native binaries for macOS, Linux, and Windows are published on GitHub Releases with checksums and signed provenance. To build from source, clone the repository and run make install.
A source build is never updated automatically. Run terma update --force to switch it to the latest published release.

​
Verify the installation

​
System requirements

  • Operating system: macOS or Linux (x86_64 or arm64). Windows binaries are available from GitHub Releases.
  • Runtime: none. The binary is self-contained.
  • Git: needed for repository matching and commit stamping.

​
Remove the CLI

Run terma teardown first to restore your agents’ settings and stop the relay. Then remove the binary with the method you installed it with, for example npm uninstall -g @miradorlabs/terma or brew uninstall terma.

​
Next step

terma setup

Sign in, choose your team and agents, and wire your machine once.