From e79f1d21508bef20b7a0b24ec729c5776837d637 Mon Sep 17 00:00:00 2001 From: junhsss Date: Sun, 13 Sep 2026 03:12:19 +0900 Subject: [PATCH] docs(cli): say a computer is deleted at its timeout unless --auto-pause is set --- docs/cli-reference.md | 16 ++++++++-------- src/commands/checkpoint.rs | 4 ++-- src/commands/computer/mod.rs | 4 ++-- src/commands/environment.rs | 4 ++-- 4 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/cli-reference.md b/docs/cli-reference.md index dc896ce..2938656 100644 --- a/docs/cli-reference.md +++ b/docs/cli-reference.md @@ -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 @@ -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 @@ -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 @@ -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 diff --git a/src/commands/checkpoint.rs b/src/commands/checkpoint.rs index 4339229..d403da9 100644 --- a/src/commands/checkpoint.rs +++ b/src/commands/checkpoint.rs @@ -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, - /// 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, diff --git a/src/commands/computer/mod.rs b/src/commands/computer/mod.rs index 28b16bb..0cd2e85 100644 --- a/src/commands/computer/mod.rs +++ b/src/commands/computer/mod.rs @@ -101,11 +101,11 @@ pub struct CreateArgs { #[arg(long = "memory", value_name = "MIB")] pub memory_mib: Option, - /// 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, - /// 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, diff --git a/src/commands/environment.rs b/src/commands/environment.rs index b1f9c59..3aa434e 100644 --- a/src/commands/environment.rs +++ b/src/commands/environment.rs @@ -68,11 +68,11 @@ pub struct SpecArgs { #[arg(long = "disk", value_name = "MIB")] pub disk_mib: Option, - /// 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, - /// 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,