Installation

Installation

Setup Terminalwire on workstations and configure the $PATH variable

Terminalwire is in beta. During the beta, the client is implemented in Ruby and installed via RubyGems. Eventually the Terminalwire client will be implemented as a self-contained binary to improve portability and reduce the dependencies needed to deploy Terminalwire to customer workstations.

Install Terminalwire via RubyGems
gem install terminalwire

Once installed, run the terminalwire command to verify it’s properly installed.

Run the base terminalwire command
terminalwire
Commands:
  terminalwire apps            # List apps installed in terminalwire directory
  terminalwire help [COMMAND]  # Describe available commands or one specific ...
  terminalwire install NAME    # Install a terminalwire app
  terminalwire list            # List installed apps in terminalwire directory
  terminalwire open            # Open terminal wire in the browser.
  terminalwire setup           # Setup terminalwire
  terminalwire uninstall NAME  # Uninstall a terminalwire app

Add Terminalwire binary path to $PATH

Next, you’ll need to set up your $PATH variable to include the terminalwire binary directory. This varies by platform and shell, which the terminalwire setup path command detects. Here’s what it looks like on macOS with zsh.

Setup the $PATH variable
terminalwire setup path
Add '.terminalwire/bin' to your PATH by running the following command:
echo 'export PATH=$PATH:.terminalwire/bin' >> ~/.zshrc

The terminalwire setup path command looks for common shell initialization files and provides instructions for how to add the Terminalwire binary directory to the $PATH variable. If the command doesn’t work, the path can be manually configure the $PATH variable.

Manual configuration

If you prefer to manually configure your shell, the following commands will add the Terminalwire binary directory to your $PATH variable.

Linux or Bash

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

macOS or zsh

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

Test the installation

To verify the installation, run the terminalwire setup verify command. If all is well, you should see a success message.

Verify the installation
terminalwire setup verify
Verifying Terminalwire installation...
✅ Terminalwire home directory is present at ".terminalwire".
✅ Terminalwire directory ".terminalwire/bin" is present in $PATH.
It appears Terminalwire is properly installed! If you're still having problems check out the docs at https://terminalwire.com/docs/client.

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