Skip to content

docs(cli): timeout options #114

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
junhsss merged 1 commit into from
Sep 12, 2026
Merged

docs(cli): timeout options #114

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions docs/cli-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1593,8 +1593,8 @@ steel computer create
- `--template` (string, optional): Template name (defaults to the only one the API offers)
- `--vcpu` (string, optional): Number of vCPUs
- `--memory` (string, optional): Memory in MiB
- `--timeout` (string, optional): Stop the computer after this many seconds of running time
- `--auto-pause` (boolean, optional): Pause instead of stopping when the timeout is reached
- `--timeout` (string, optional): Delete the computer after this many seconds of running time
- `--auto-pause` (boolean, optional): Pause instead of deleting when the timeout is reached
- `--idle-timeout` (string, optional): Pause after this many seconds without incoming traffic (0 disables it)
- `--env` (string[], optional): Environment variable for the computer, repeatable
- `--secret` (string[], optional): Attach a stored secret as an environment variable, repeatable
Expand Down Expand Up @@ -1869,8 +1869,8 @@ steel checkpoint restore
### Parameters

- `checkpoint_id` (string, required): Checkpoint ID
- `--timeout` (string, optional): Stop the computer after this many seconds of running time
- `--auto-pause` (boolean, optional): Pause instead of stopping when the timeout is reached
- `--timeout` (string, optional): Delete the computer after this many seconds of running time
- `--auto-pause` (boolean, optional): Pause instead of deleting when the timeout is reached
- `--idle-timeout` (string, optional): Pause after this many seconds without incoming traffic (0 disables it)
- `--wait` (boolean, optional): Wait until the computer is running
- `--use` (boolean, optional): Make the new computer the default for other commands
Expand Down Expand Up @@ -2021,8 +2021,8 @@ steel environment create
- `--vcpu` (string, optional): Number of vCPUs
- `--memory` (string, optional): Memory in MiB
- `--disk` (string, optional): Disk in MiB
- `--timeout` (string, optional): Stop computers after this many seconds of running time
- `--auto-pause` (boolean, optional): Pause instead of stopping when the timeout is reached
- `--timeout` (string, optional): Delete computers after this many seconds of running time
- `--auto-pause` (boolean, optional): Pause instead of deleting when the timeout is reached
- `--env` (string[], optional): Environment variable for computers, repeatable
- `--secret` (string[], optional): Attach a stored secret as an environment variable, repeatable
- `--secret-value` (string[], optional): Store a new secret and attach it, repeatable
Expand Down Expand Up @@ -2061,8 +2061,8 @@ steel environment update
- `--vcpu` (string, optional): Number of vCPUs
- `--memory` (string, optional): Memory in MiB
- `--disk` (string, optional): Disk in MiB
- `--timeout` (string, optional): Stop computers after this many seconds of running time
- `--auto-pause` (boolean, optional): Pause instead of stopping when the timeout is reached
- `--timeout` (string, optional): Delete computers after this many seconds of running time
- `--auto-pause` (boolean, optional): Pause instead of deleting when the timeout is reached
- `--env` (string[], optional): Environment variable for computers, repeatable
- `--secret` (string[], optional): Attach a stored secret as an environment variable, repeatable
- `--secret-value` (string[], optional): Store a new secret and attach it, repeatable
Expand Down
4 changes: 2 additions & 2 deletions src/commands/checkpoint.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,11 @@ pub struct RestoreArgs {
/// Checkpoint ID
pub checkpoint_id: String,

/// Stop the computer after this many seconds of running time
/// Delete the computer after this many seconds of running time
#[arg(long = "timeout", value_name = "SECONDS")]
pub timeout_seconds: Option<u32>,

/// Pause instead of stopping when the timeout is reached
/// Pause instead of deleting when the timeout is reached
#[arg(long = "auto-pause")]
pub auto_pause: bool,

Expand Down
4 changes: 2 additions & 2 deletions src/commands/computer/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,11 +101,11 @@ pub struct CreateArgs {
#[arg(long = "memory", value_name = "MIB")]
pub memory_mib: Option<u32>,

/// Stop the computer after this many seconds of running time
/// Delete the computer after this many seconds of running time
#[arg(long = "timeout", value_name = "SECONDS")]
pub timeout_seconds: Option<u32>,

/// Pause instead of stopping when the timeout is reached
/// Pause instead of deleting when the timeout is reached
#[arg(long = "auto-pause")]
pub auto_pause: bool,

Expand Down
4 changes: 2 additions & 2 deletions src/commands/environment.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,11 @@ pub struct SpecArgs {
#[arg(long = "disk", value_name = "MIB")]
pub disk_mib: Option<u32>,

/// Stop computers after this many seconds of running time
/// Delete computers after this many seconds of running time
#[arg(long = "timeout", value_name = "SECONDS")]
pub timeout_seconds: Option<u32>,

/// Pause instead of stopping when the timeout is reached
/// Pause instead of deleting when the timeout is reached
#[arg(long = "auto-pause")]
pub auto_pause: bool,

Expand Down
Loading