Command line
Everything the interface does, the command line does too. In a Linux session without a display, quickssh without arguments doesn't try to open the interface and lists the commands instead.
VPN
| Command | What it does |
|---|
quickssh add <name> --kind <type> … | Adds a VPN profile |
quickssh edit <name> … | Edits the profile; only the given fields change |
quickssh up [names…] [--otp CODE] | Starts (all if no name is given) |
quickssh down [names…] | Stops (all running ones if no name is given) |
quickssh restart <name> | Stops and starts again |
quickssh logs <name> [-f] [-n 100] | Container log |
quickssh tunnel <name> [--close] | SSH tunnel and proxy details |
quickssh run <vpn> -- <command> | Sends only this program through the VPN |
Sessions
| Command | What it does |
|---|
quickssh add-ssh <name> --host … -u … [--vpn | --jump] | Adds an SSH session |
… --sftp, … --ftp [--tls], … --rdp [--domain], … --vnc | A file or remote desktop session |
… --db postgres|mysql|mssql|redis [--database] [--local-port] | A database record |
quickssh edit-ssh <name> … | Edits the session |
quickssh connect <name> | Connects; starts the VPN first if it is down |
quickssh exec <name> [--timeout 60] -- <command> | Runs a single command without prompts |
quickssh fs ls|get|put <session> … | Files of SFTP and FTP sessions |
quickssh db open|close|ls | Database ports |
Managing records
| Command | What it does |
|---|
quickssh ls [--json] | Records and VPN states |
quickssh show <name> | Record details; passwords are not printed |
quickssh rm <names…> [--yes] | Deletes; asks for confirmation |
quickssh group ls | Groups and their members |
quickssh group set <group> <records…> | Moves records into a group |
quickssh group unset <records…> | Leaves them without a group |
quickssh group rename <old> <new>, group rm <group> | Renames or removes a group |
quickssh note ls|add|attach|save|rm | Notes and their files |
quickssh license [set|remove] | License status, applying or removing a key |
Security and backup
| Command | What it does |
|---|
quickssh vault set | Sets or changes the master password |
quickssh vault status | Shows the encryption state |
quickssh vault reset | Deletes all records (if the password is forgotten) |
quickssh export <file> | Writes the records to an encrypted file |
quickssh import <file> [--overwrite] | Adds the records in the file |
quickssh unlock [code], quickssh lock | The OTP lock on a central server |
Server and settings
| Command | What it does |
|---|
quickssh server show | Which server, and your identity there |
quickssh server set <user@address> [--port] [-i key] | Sets the central server |
quickssh server off, quickssh server on | Switches to the local server / back |
quickssh log [day] [-n 50] [--source name] [--days] | Activity log |
quickssh settings [--language] [--mcp] [--mcp-exec] | Preferences |
quickssh bridge [--token] | The local bridge for the browser extension |
quickssh build | Rebuilds the VPN image |
quickssh install-desktop | Adds the app to the desktop menu |
quickssh mcp | MCP server for AI tools |
Example: an environment from scratch
quickssh vault set
quickssh add acme --kind fortigate --host vpn.acme.com -u alice
quickssh add-ssh web --host 10.20.0.15 -u deploy --vpn acme --group Acme
quickssh add-ssh sales --db postgres --host 10.20.0.9 -u report --database sales --vpn acme --group Acme
quickssh connect web
quickssh db open sales
quickssh export ~/quickssh-backup.qsx
Only in the interface
Remote desktop (RDP, VNC) tabs, macros and the server status bar need a display, so they exist only in the interface.