Documentation Index
Fetch the complete documentation index at: https://docs.microsandbox.dev/llms.txt
Use this file to discover all available pages before exploring further.
See SSH for usage flows.
Sandbox
SSH()
func (s *Sandbox) SSH() *SSH
| Type | Description |
|---|
*SSH | SSH client and server helpers |
SSH
Connect()
func (ssh *SSH) Connect(ctx context.Context, opts ...SSHClientOption) (*SSHClient, error)
| Name | Type | Description |
|---|
| ctx | context.Context | Cancels the connection attempt |
| opts | ...SSHClientOption | Client options |
| Type | Description |
|---|
*SSHClient | Native SSH client session |
error | Typed microsandbox error |
Server()
func (ssh *SSH) Server(ctx context.Context, opts ...SSHServerOption) (*SSHServer, error)
| Name | Type | Description |
|---|
| ctx | context.Context | Cancels server preparation |
| opts | ...SSHServerOption | Server options |
| Type | Description |
|---|
*SSHServer | Server endpoint |
error | Typed microsandbox error |
SSHClient
Exec()
func (c *SSHClient) Exec(ctx context.Context, command string, opts ...SSHExecOption) (*SSHOutput, error)
| Name | Type | Description |
|---|
| ctx | context.Context | Cancels the exec request |
| command | string | Command string sent through SSH |
| opts | ...SSHExecOption | Exec options |
| Type | Description |
|---|
*SSHOutput | Captured output and status |
error | Typed microsandbox error |
Attach()
func (c *SSHClient) Attach(ctx context.Context, opts ...SSHAttachOption) (int, error)
| Name | Type | Description |
|---|
| ctx | context.Context | Cancels the attach session |
| opts | ...SSHAttachOption | Attach options |
| Type | Description |
|---|
int | Exit code |
error | Typed microsandbox error |
SFTP()
func (c *SSHClient) SFTP(ctx context.Context) (*SFTPClient, error)
| Type | Description |
|---|
*SFTPClient | SFTP client session |
error | Typed microsandbox error |
Close()
func (c *SSHClient) Close(ctx context.Context) error
SFTPClient
| Method | Returns | Description |
|---|
| Read(ctx, path) | ([]byte, error) | Read a file into memory |
| Write(ctx, path, data) | error | Create or truncate a file |
| Mkdir(ctx, path) | error | Create a directory |
| RemoveFile(ctx, path) | error | Remove a file |
| RemoveDir(ctx, path) | error | Remove an empty directory |
| Rename(ctx, oldPath, newPath) | error | Rename a file or directory |
| RealPath(ctx, path) | (string, error) | Resolve a canonical path |
| ReadLink(ctx, path) | (string, error) | Read a symlink target |
| Symlink(ctx, target, linkPath) | error | Create a symlink |
| Close(ctx) | error | Close the SFTP session |
SSHServer
ServeStdio()
func (srv *SSHServer) ServeStdio(ctx context.Context) error
Close()
func (srv *SSHServer) Close(ctx context.Context) error
Types
SSHOutput
| Field / Method | Type | Description |
|---|
| Status | int | Exit status code |
| Stdout | []byte | Captured stdout bytes |
| Stderr | []byte | Captured stderr bytes |
| Success() | bool | true if status is 0 |
SSHClientOption
| Option | Description |
|---|
| WithSSHUser(user) | SSH login user. Defaults to root |
| WithSSHTerm(term) | Terminal name for interactive sessions |
| WithSSHClientSFTP(enabled) | Enable or disable SFTP on the internal server |
SSHExecOption
| Option | Description |
|---|
| WithSSHTTY(enabled) | Request a PTY for the exec channel |
SSHAttachOption
| Option | Description |
|---|
| WithSSHAttachTerm(term) | Terminal name for the shell |
| WithSSHDetachKeys(keys) | Detach key sequence |
SSHServerOption
| Option | Description |
|---|
| WithSSHHostKeyPath(path) | Override the host private key path |
| WithSSHAuthorizedKeysPath(path) | Override the authorized-keys path |
| WithSSHServerUser(user) | Override the guest user used for exec requests |
| WithSSHServerSFTP(enabled) | Enable or disable SFTP |
