Skip to main content
Link
Menu
Expand
(external link)
Document
Search
Copy
Copied
SSHScript Documentation
SSHScript Documentation
Recommended SSHScript API
Getting Started
Installation and Verification
5-Minute Quickstart
Your First SSH Connection
Module API or Dollar Syntax?
Installation Troubleshooting
Tutorials
Module API Tutorial
Dollar Syntax Tutorial
How-to Guides
Running Commands and Shell Pipelines
Connections, Authentication, and Bastions
Using Session.sudo()
Using Session.su()
Interactive Programs with Session.enter()
Uploading and Downloading Files
Streaming and Looping Output
Concurrency and Threading
CLI and Script Composition
Concepts
Session Lifecycle
Direct Execution vs Shell Execution
Results and Error Model
How .spy Transformation Works
Reference
Session and Console API Reference
Dollar Syntax Reference
CLI and Environment Variables
Exceptions and Return Values
Security and Operations
Failure Model and Production Checklist
Host Keys, Credentials, and Command Injection
Timeouts, Cancellation, and Cleanup
Runtime Troubleshooting
Example Gallery
System Administration
Networking
Accounts
Migration and Releases
Migrating to v3.1
Release Notes
Version policy and 5.0 migration
Contributing and Testing
SSHScript for AI Agents
SSHScript Agent Guide
Search SSHScript Documentation
GitHub
PyPI
Latest Release
Accounts (legacy URL)
This misspelled legacy page has moved to
Accounts
.
Last Updated: 2026-09-19 13:16:26