Knot Documentation

Knot is a native-terminal SSH/SFTP manager. It does not provide a TUI and does not replace the terminal emulator you already use. It brings server profiles, authentication, jump hosts, proxies, file transfer, remote execution, port forwarding, and connection reuse into one CLI workflow.

curl -fsSL https://knot.clay.li/i/install.sh | sh

Windows PowerShell:

irm https://knot.clay.li/i/install.ps1 | iex

Daily Workflow

SSH

Save a server alias, then use knot ssh alias or the shortcut knot alias to open a remote shell.

SFTP

Use the interactive SFTP shell, or run direct operations with alias:/path remote paths.

Proxy and Jump Hosts

Server profiles can reference managed proxies and comma-separated jump host chains.

Daemon

The background daemon owns the SSH connection pool so SSH, exec, SFTP, cp, and forward operations can reuse connections.

Quick Example

knot add web-prod --host 1.2.3.4 --user deploy --key deploy-key --tags prod
knot web-prod
knot exec web-prod "uptime" --json
knot cp ./dist/. web-prod:/var/www/html/

Documentation Structure

• Install and Quick Start: install Knot, add a server, connect, and copy files.
• SSH Connections: server profiles, connection entry points, shortcuts, and jump hosts.
• SFTP and File Copy: interactive SFTP, batch SFTP commands, and knot cp.
• Proxy: managed HTTP/SOCKS5 proxies and server references.
• Port Forwarding: local, remote, and dynamic SOCKS5 forwarding.
• Servers and Global Config: server CRUD, global settings, and config import/export.