Start here

These pages explain every part of Vaulterm: what each screen does, how to get a task done, and the details you only find out the hard way. They describe the version on the download page. Parts that arrive in a later release appear here when that release does.

If you’re new to Vaulterm, read the first three pages in order.

Getting started

• Install Vaulterm on macOS, Windows or Linux, and how updates work.
• Set up your vault: the master password and the Recovery Key.
• Your first connection, from typing an address to saving a host.
• Bring your hosts over from ~/.ssh/config or PuTTY.

Everyday use

• The Command Center: one search box for hosts, snippets, files, settings and actions.
• Home: recent servers, and picking up where you left off.
• Tabs and split panes, and arranging them by dragging.
• Smart panes: what runs in each terminal, and buttons for the web addresses it prints.
• Agents: every coding agent in your terminals, and starting one.
• Saved layouts for the tabs you open every day.

Servers

• Hosts, with every field in the host editor.
• Groups and inheritance: set a login, port or theme once for many hosts.
• Connecting and signing in: keys, passwords, two-factor, agents and jump hosts.
• Host keys and trust.
• Scan network for SSH servers on your local network.

Keys and identities

• SSH keys: generate, import, and put them on servers.
• Identities: a username and a way of signing in, shared by many hosts.

Working on servers

• Snippets: saved commands with variables, run on one host or many.
• Files: browse, upload, download and edit over SFTP.
• Connections: SFTP, FTP and FTPS servers and S3 buckets, each in a tab of files.

• Telnet, rlogin and Serial: switches, routers and console cables, as terminals.

• Tunnels: local, remote and SOCKS port forwards.

Make it yours

• Themes and accents.
• Keyboard shortcuts, and changing them.
• Settings reference: every setting, what it does and its default.

Vaulterm Code

• Environments: a project’s .env secrets in the vault.

Security and help

• The vault: what’s encrypted, locking, and changing your password.
• Troubleshooting: what error messages mean and what to do about them.