跳转到主要内容

CLI 参考

ClawAgora CLI 命令、选项和配置的完整参考。

身份验证命令

clawagora auth login

使用您的 ClawAgora 账户进行身份验证。
clawagora auth login [--api-key <key>]
选项:
  • --api-key <key> - 您从控制面板获取的 API 密钥

clawagora auth logout

退出您的 ClawAgora 账户。
clawagora auth logout

clawagora auth whoami

显示当前身份验证状态。
clawagora auth whoami [--json]
选项:
  • --json - JSON 格式输出

实例命令

clawagora instance list

列出您的所有实例。
clawagora instance list [--json]
选项:
  • --json - JSON 格式输出

clawagora instance status

显示您的实例状态。
clawagora instance status [<instance-id>] [--json]
参数:
  • instance-id - 特定实例 ID(可选,不填则列出全部)
选项:
  • --json - JSON 格式输出

clawagora instance create

创建新实例。
clawagora instance create [--name <name>] [--template <template-id>] [--json]
选项:
  • --name <name> - 实例名称
  • --template <template-id> - 使用的模板 ID
  • --json - JSON 格式输出

clawagora instance delete

删除实例。
clawagora instance delete <instance-id> [--force]
参数:
  • instance-id - 要删除的实例 ID
选项:
  • --force - 跳过确认提示

clawagora instance start

启动已停止的实例。
clawagora instance start <instance-id>
参数:
  • instance-id - 要启动的实例 ID

clawagora instance stop

停止正在运行的实例。
clawagora instance stop <instance-id>
参数:
  • instance-id - 要停止的实例 ID

clawagora instance restart

重启实例。
clawagora instance restart <instance-id>
参数:
  • instance-id - 要重启的实例 ID

clawagora instance logs

查看实例日志。
clawagora instance logs <instance-id> [--follow] [--lines <n>]
参数:
  • instance-id - 实例 ID
选项:
  • --follow - 实时跟踪日志输出
  • --lines <n> - 显示的行数(默认:50)

全局选项

选项描述
--jsonJSON 格式输出
--token <token>身份验证的 API 令牌
--api-url <url>自定义 API URL
--debug启用调试输出
--version显示版本号
--help显示帮助信息

配置

CLI 可以使用配置文件进行配置。默认情况下,它会查找 ~/.clawagora/config.json 配置示例:
{
  "apiUrl": "https://api.clawagora.com",
  "token": "your-api-token",
  "defaultRegion": "us-west-1"
}
配置文件位置(按优先级顺序):
  1. ./.clawagora/config.json(项目级别)
  2. ~/.clawagora/config.json(用户级别)
  3. 环境变量(CLAWAGORA_API_URLCLAWAGORA_TOKEN