Skip to main content

CLI reference

sshnav [COMMAND]

With no command, sshnav opens the interactive picker.

sshnav pick [QUERY]​

Open the picker with an optional initial fuzzy-search query.

sshnav connect <ALIAS>​

Connect directly to a saved alias. Unknown aliases return a suggestion when a close match exists.

File transfers​

sshnav send <ALIAS> <LOCAL_SOURCE> [REMOTE_DESTINATION] [OPTIONS]
sshnav receive <ALIAS> <REMOTE_SOURCE> [LOCAL_DESTINATION] [OPTIONS]
ArgumentMeaningDefault
ALIASSaved sshnav hostrequired
LOCAL_SOURCELocal file or directory to sendrequired
REMOTE_SOURCERemote file or directory to receiverequired
REMOTE_DESTINATIONRemote directory or renamed path.
LOCAL_DESTINATIONLocal directory or renamed path.

-r, --recursive enables directory copying. --rsync switches from the default scp backend to rsync -avzP, with protected remote arguments; rsync must be installed locally and remotely.

Host management​

sshnav host list [--json] [--group <GROUP>] [--tag <TAG>] [--user <USER>]​

List saved hosts as aligned text or JSON. Secret bytes are never returned. --group, --tag, and --user keep hosts whose group, tags, or user contain the given substring. Repeat --tag or pass comma-separated values.

sshnav host search <QUERY> [--json]​

Filter and fuzzy-rank hosts. The query uses the same prefixes as the picker (g:/group:, t:/tag:, u:/user:, unreachable:/reachable:) plus remaining free text.

sshnav host add​

sshnav host add --alias <ALIAS> --hostname <HOSTNAME> --user <USER> [OPTIONS]
OptionMeaning
--port <PORT>Non-default SSH port
--tag <TAG>Tag; repeat or pass comma-separated values
--display-name <NAME>Longer human-readable name
--group <GROUP>Picker grouping value
--identity-file <PATH>Validate, encrypt, and import a private key
--template <NAME>Connection template, such as mosh
--proxy-jump <VALUE>Saved alias or literal OpenSSH ProxyJump route
--auto-reconnectEnable bounded reconnect after live transport loss

sshnav host edit <ALIAS> [OPTIONS]​

Uses the same mutable fields as host add. Additional flags:

OptionMeaning
--no-proxy-jumpClear the saved jump route
--no-auto-reconnectDisable reconnect

sshnav host duplicate <SOURCE_ALIAS> <NEW_ALIAS>​

Copy every saved host field and create an independent encrypted-key record.

sshnav host rename <CURRENT_ALIAS> <NEW_ALIAS>​

Change a host's alias. Saved ProxyJump hops that named the old alias are rewritten. Encrypted private-key records move with the host.

sshnav host remove <ALIAS>​

Delete a host and its associated child records and secrets.

Key management​

sshnav host update-key <ALIAS> --from <PATH>
sshnav host remove-key <ALIAS>
sshnav host forget-key-source <ALIAS>

update-key validates and replaces the encrypted key. remove-key removes the encrypted copy and source metadata. forget-key-source retains the encrypted copy while removing only its source path.

OpenSSH interoperability​

sshnav import ssh-config [--from <PATH>]
sshnav migrate [--from <PATH>]
sshnav generate [--install-include] [--yes]

Import and migrate default to ~/.ssh/config. Generate writes the managed include; --install-include offers to add it to the user's config and --yes accepts the prompt.

Diagnostics​

sshnav doctor [ALIAS]

Without an alias, check local environment health. With an alias, resolve and probe its jump chain and target.

Shell completions​

sshnav completions <SHELL>

Generate completion code for Bash, Elvish, Fish, PowerShell, or Zsh. For example:

sshnav completions bash > ~/.local/share/bash-completion/completions/sshnav
sshnav completions fish > ~/.config/fish/completions/sshnav.fish
sshnav completions zsh > ~/.zfunc/_sshnav

Global options​

OptionMeaning
-h, --helpPrint contextual command help
-V, --versionPrint the sshnav version

Exit behavior​

  • Parse errors return 2.
  • Local validation and application errors are reported without invoking SSH, SCP, or rsync.
  • Connections and transfers propagate the native child's exit status where available.
  • A child terminated without an exit code maps to 1.