Installation

Setup Terminalwire on workstations and configure the $PATH variable

Most people install Terminalwire by installing an app: the app’s one-liner installs the Terminalwire client for you, then drops the app’s launcher on your $PATH. For example, to install the ogplus app:

Installs the Terminalwire client and the ogplus app on Linux or macOS
curl -sSL https://ogplus.terminalwire.sh | bash
Restart your terminal to complete the installation

If you just want the client itself, without any app, install it from the bare domain:

Installs only the Terminalwire client
curl -sSL https://terminalwire.sh | bash

The installer does the following on your workstation:

  1. Downloads the Terminalwire client (a single self-contained binary, terminalwire-exec) to ~/.terminalwire/bin. No Ruby, Node, or other runtime is required.
  2. Detects and configures your shell initialization file to include ~/.terminalwire/bin in your $PATH variable.
  3. Creates a ~/.terminalwire directory to store configuration, per-app permissions, and installed app launchers.
  4. Installs any app launcher bundled with the one-liner (e.g. ogplus) into ~/.terminalwire/usr/bin.

Verify the client is installed by printing its version:

terminalwire-exec --version
2.0.8

That’s it! You have successfully installed Terminalwire on your workstation. If you installed an app, restart your terminal and run it by name (e.g. ogplus).

Staying up to date

The client keeps itself current. It checks for new versions in the background and applies signed updates automatically, so you never reinstall. To check and update on demand:

Force an update check now
terminalwire-exec update
already up to date (2.0.8)

Updates are served over a signed release channel; stable is the default. Advanced users can track a faster train (alpha, beta) when switching channels is supported by their client version.

Manual configuration

The installer edits your shell rc file for you. If you prefer to configure your shell manually, add the Terminalwire binary directory to your $PATH.

Linux or Bash

Linux or bash
echo 'export PATH=$HOME/.terminalwire/bin:$PATH' >> ~/.bashrc
Reload your shell or run...
source ~/.bashrc

macOS or zsh

macOS or zsh
echo 'export PATH=$HOME/.terminalwire/bin:$PATH' >> ~/.zshrc
Reload your shell or run...
source ~/.zshrc

Test the installation

To verify the client can reach a server and negotiate the protocol, run terminalwire-exec inspect against a server URL. You’ll see the negotiated protocol and the capabilities the server offers:

terminalwire-exec inspect wss://opengraphplus.com/terminal
Server inspection
  endpoint:     wss://opengraphplus.com/terminal
  protocol:     v2
  version:      2
  capabilities: stdio, file, directory, browser, env, signal, flow, raw-input, terminal-query

Once verified, you’re ready to start installing apps and using Terminalwire on your workstation.