docs: add CLI docs for user, upgrade, and disk commands (#2383)
* docs: add CLI docs for user, upgrade, and disk commands * docs: update based on comments * docs: fix typo * docs: refine formatting and add description for argument * docs: resolve conflicts
This commit is contained in:
33
docs/zh/developer/install/cli/user-get.md
Normal file
33
docs/zh/developer/install/cli/user-get.md
Normal file
@@ -0,0 +1,33 @@
|
||||
# `get`
|
||||
|
||||
## 命令说明
|
||||
|
||||
`get`子命令用于获取 Olares 指定用户的详细信息。输出结果以表格或 JSON 格式显示。
|
||||
|
||||
```bash
|
||||
olares-cli user get <用户名> [选项]
|
||||
```
|
||||
|
||||
## 参数
|
||||
|
||||
| 参数 | 说明 | 是否必需|
|
||||
|--|--|--|
|
||||
| `<用户名>` | 指定要查询的用户名。通常为 Olares ID 中`@`符号之前的部分。<br>例如 `alice123@olares.com`中的`alice123`。| 是 |
|
||||
|
||||
## 选项
|
||||
| 选项 | 简写 | 用途 | 是否必需 | 默认值 |
|
||||
|--|--|--|--|--|
|
||||
| `--help` | `-h` | 显示帮助信息。 | 否 | 无 |
|
||||
| `--kubeconfig` | | 指定 kubeconfig 文件路径。 | 否 | 无 |
|
||||
| `--no-headers` | | 输出结果不显示表头。 | 否 | 无 |
|
||||
| `--output` | `-o` | 指定输出格式。<br>可选值:`table`、`json`。 | 否 | `table` |
|
||||
|
||||
## 使用示例
|
||||
|
||||
```bash
|
||||
# 以默认表格格式查看用户 alice123 的信息
|
||||
olares-cli user get alice123
|
||||
|
||||
# 以 JSON 格式查看用户 blake123 的信息
|
||||
olares-cli user get blake123 -o json
|
||||
```
|
||||
Reference in New Issue
Block a user