Guide
Task-oriented walkthroughs. Each topic is one short page; the API reference for every type touched lives in API.
-
Connect
Scoped
withConnection, manual ownership, lifecycle and cancellation. - Authentication Password, private-key file, keyboard-interactive, agent. Discover what the server offers. Includes key generation.
- Host trust Policies, known-hosts files, pinned fingerprints, and the discover → confirm → save → connect Keychain bootstrap.
-
Commands
Collected
executevs streamedopenCommand, exit status, exit signal. - PTY shell Interactive shells with resize, terminal type, and event handlers.
- SFTP List, stat, mkdir, rename, symlinks, file handles, whole-file I/O, progress, resumable transfers.
- SCP Single-file upload and download. Swift-only.
- Forwarding & tunnels Direct TCP channels, local (-L), remote (-R), dynamic SOCKS (-D).
- Proxy routes SOCKS5, HTTP CONNECT, ProxyJump on the configuration.
- Diagnostics Log handlers, bounded recorder, redacted reports, algorithm inspection, latency probe.