Skip to main content

termix exec and termix ssh

Two ways to run things on a server. exec runs one command and comes back. ssh opens a terminal you sit in.

termix exec​

termix exec <hostId> <command...>

Runs a command on a host, prints the output, and exits with whatever the command exited with.

termix exec 3 uptime
termix exec 3 df -h
termix exec 3 "systemctl restart nginx && systemctl is-active nginx"

Quote anything containing &&, |, ;, or > so your own shell does not take it first.

It gives you the real exit code​

The exit code you get back is the one from the server:

termix exec 3 "test -f /etc/nginx/nginx.conf"
echo $? # 0 if the file is there, 1 if not

That makes it safe to use in an if:

if termix exec 3 "systemctl is-active --quiet nginx"; then
echo "running"
fi

An exit code of 255 means the CLI could not run the command at all, rather than the command failing.

Use this one in scripts​

exec works with an API key, so it is the right choice for cron jobs and CI. See Scripting.

termix ssh​

termix ssh <hostId>

Opens a proper interactive terminal, the same connection the web app uses. Full colour, resizing, and Ctrl+C all work as normal.

OptionWhat it does
--command <command>Run this instead of opening a shell
--path <path>Start in this directory
--tmux <session>Attach to a tmux session by name
--trust-host-keyTrust a host key seen for the first time without asking
termix ssh 3
termix ssh 3 --path /var/log
termix ssh 3 --tmux deploy

The first time you connect to a host, it shows the host key and asks whether to trust it, the same as the web app. If the key has changed since, you get a warning and have to confirm it yourself. --trust-host-key only skips the question for a new key, never a changed one.

If the host's key needs a passphrase, or the host asks for a verification code or password, you are asked for it. Hosts that need a browser sign-in only work from the web app.

It needs a real login​

termix ssh does not work with an API key, because interactive terminals use a websocket and API keys cannot open one. Run termix login first, or use termix exec in a script.

Which one to use​

SituationUse
Working by hand on a serverssh
One quick commandexec
Anything in a script or CIexec
Authenticating with an API keyexec
Attaching to tmuxssh --tmux

Running on many hosts​

For the same command across a group of servers, use fleets instead of a loop:

termix fleets exec 2 "apt-get update"

See Fleets.