Skip to content

Commit bc89062

Browse files
committed
chore(cli): standardize help and usage errors
1 parent da2427a commit bc89062

5 files changed

Lines changed: 234 additions & 59 deletions

File tree

docs/development/cli.en.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,12 @@ Additional flags on specific commands:
9696
- `config password set --stdin`: reads the passphrase from stdin
9797
- `auth ip unblock --all`: removes all currently blocked IPs at once
9898

99+
## Exit Codes
100+
101+
- `0`: success
102+
- `1`: runtime or operation failure
103+
- `2`: command usage, argument, or input validation failure
104+
99105
## Runtime Commands
100106

101107
### `start`

docs/development/cli.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,12 @@ coder-studio --version
9696
- `config password set --stdin`:从标准输入读取口令
9797
- `auth ip unblock --all`:一次解除全部当前封禁 IP
9898

99+
## 退出码
100+
101+
- `0`:执行成功
102+
- `1`:运行时或操作失败
103+
- `2`:命令用法、参数或输入值错误
104+
99105
## 运行时命令
100106

101107
### `start`

0 commit comments

Comments
 (0)