sshnav documentation
███████ ██████ ██ ██ ███ ██ █████ ██ ██ ██ ██ ██ ██ ████ ██ ██ ██ ██ ██ ███████ ██████ ███████ ██ ██ ██ ███████ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ███████ ██████ ██ ██ ██ ████ ██ ██ ████
Current release: v0.1.3
sshnav is a local SSH inventory, searchable terminal picker, connection launcher, and file-transfer frontend. It stores the details that are easy to forget—aliases, users, ports, jump routes, tags, forwards, options, and identity metadata—then launches native ssh, scp, or optional rsync directly.
Read the story behind this project.
What sshnav owns
- A SQLite inventory of hosts and templates.
- Encrypted copies of imported private keys.
- Optional generated OpenSSH configuration.
- Interactive add, edit, duplicate, and picker experiences.
What OpenSSH owns
- The SSH protocol and authentication exchange.
- Host-key verification and
known_hosts. - Password prompts, SSH agents, and agent forwarding.
- Network transport for SSH, SCP, and rsync.
Start here
Install sshnav, add one host, and open the picker with the three-minute quickstart.
Core workflows
| Goal | Command |
|---|---|
| Open the picker | sshnav |
| Connect by alias | sshnav connect prod |
| Copy a file to a host | sshnav send prod ./release.tar . |
| Copy logs from a host | sshnav receive prod /var/log/app.log . |
| Inspect a jump chain | sshnav doctor prod |
| Import OpenSSH hosts | sshnav import ssh-config |
Continue with core concepts, or jump directly to the CLI reference.