Quick Start

Quick Start

Get productive with neossh in 2 minutes.

---

1. Launch

neossh

neossh reads your ~/.ssh/config (and any Include files) and presents all configured servers in an interactive terminal user interface (TUI).

---

2. Navigate

Key	Action
j / k or ↓ / ↑	Move cursor up / down through the server list
Tab / Shift+Tab	Cycle focus between Search, Servers, Active, Details panels
0 / 1 / 2 / 3	Jump focus directly to Search / Servers / Active / Details

---

3. Connect

Press Enter on any server to open an SSH session. neossh suspends the TUI and launches your system's native ssh binary. When the SSH session ends, the TUI seamlessly restores.

---

4. Search & Filter

Press / or 0 to activate fuzzy search. Type to filter by alias, hostname, IP, user, or tags.

tag:prod user:root status:up web

See Search-and-Navigation for the full filter syntax.

---

5. Quick Actions

Key	Action
a	Add new server
e	Edit selected server
d	Delete selected server (with confirmation)
D	Deploy and sync personal dotfiles via chezmoi archive
c	Copy SSH command to system clipboard
o	Open SCP command generator modal
M	Open SSHFS remote mount generator modal
f	Open SSH port forwarding & tunnel assistant
F	Launch SFTP session / configured external file manager
Ctrl+F	Open built-in dual-pane SFTP manager directly
G	Parallel ping all servers with color-coded latency badges
t	Edit tags stored in SSH config comments
T	Toggle color theme (Dark → Light → System)

---

6. CLI Shortcuts

# Launch interactive companion tools setup wizard
neossh --setup

# Connect directly without opening the TUI picker
neossh -c my-server

# Pre-filtered view (great for screen shares)
neossh prod

# Quick SFTP session
neossh --sftp web-prod

# Generate SCP upload/download commands
neossh --scp web-prod

# Safe read-only mode for production environments
neossh -r

# Connect and exit immediately when session ends (one-shot)
neossh -c -x my-server

---

Next: read the comprehensive Server-Management guide!