SSHScript Documentation
SSHScript aims to help engineers and AI agents execute, understand, and hand off automation reliably. Use the regular Python Session API first; optional Dollar syntax shares the same execution semantics. Retain the command’s host, output, status and installed version, distinguish failure from timeout, and reconcile unknown termination. A zero exit status does not prove deployment success; closing an SSH channel does not prove its remote process stopped.
The published example baseline is 3.1.5. The current production contract is 5.0.0, with host-key source changes from 4.0.2 and execution changes from 3.1.5; see version policy and migration. Start with the canonical API guide for version-labelled examples and lifetime rules.
The documentation is organized by reader intent: start with a credential-free success, then use task guides, concepts, and reference for exact contracts.
| Section | Purpose |
|---|---|
| Getting Started | Install the intended version and obtain the first successful result. |
| Tutorials | Learn the Module API first, then the optional Dollar syntax. |
| How-to Guides | Complete focused command, SSH, privilege, interactive, transfer, streaming, and concurrency tasks. |
| Concepts | Understand lifecycle, execution modes, results, errors, and .spy transformation. |
| Reference | Look up public signatures, options, results, and exceptions. |
| Security and Operations | Prepare automation for failure, security review, and production operation. |
| Example Gallery | Learn SSHScript through complete, safety-labelled teaching cases. |
| Migration and Releases | Update earlier code and review current and historical releases. |
| Contributing and Testing | Run the release gate and work on SSHScript itself. |
| SSHScript for AI Agents | Share one URL, follow the agent reading order, or download the portable skill. |
English is the maintained navigation language for this phase; existing translated files remain in source but are excluded from the published site and sidebar. The Example Gallery uses an append-only, one-page-per-case structure so future teaching cases can be published without reorganizing established links. SSHScript Ops is the companion project for reusable recipes and operations management workflows. It is currently an initial documentation scaffold, without executable recipes or an implemented management system.
Last Updated: 2026-10-10 19:43:07