CLI 对需要认证的命令使用 API key。你可以通过 youka login 一次性保存它,或在 CI 等非交互环境中通过 YOUKA_API_KEY 提供。
youka login 会在保存前通过 API 验证该 key,然后将解析到的账户邮箱缓存到 ~/.youka/config.json 中,用于诊断。
login
将 API key 保存到 ~/.youka/config.json。
从 Youka dashboard 复制的 API key。如果省略,CLI 会在交互式终端中提示你输入。
youka login yk_live_abcd1234
youka login yk_live_abcd1234 --api https://staging-api.youka.test --json
在 CI 中,建议优先使用 YOUKA_API_KEY,而不是写入配置文件。
logout
从 ~/.youka/config.json 中移除已保存的 API key。
youka logout
youka logout --json
whoami
检查解析后的 key 来源、API URL 和账户身份。
youka whoami
youka whoami --json
响应示例:
{
"ok": true,
"data": {
"authenticated": true,
"tokenPresent": true,
"authStatus": "verified",
"identitySource": "live",
"keySource": "config",
"apiUrl": "https://api.youka.io/zh/api/v1",
"apiUrlSource": "default",
"email": "user@example.com",
"userId": "user_123",
"apiKeyId": "key_123",
"org": null,
"configPath": "/Users/you/.youka/config.json",
"apiKeyPreview": "yk_l...1234"
}
}
解析顺序
| 字段 | 顺序 |
|---|
| API key | YOUKA_API_KEY,然后 ~/.youka/config.json |
| API URL | --api,然后 YOUKA_API_BASE_URL,然后 ~/.youka/config.json,然后默认值 |
当启用已保存的 config key 时,whoami 会通过 API 验证身份;只有在实时查询不可用时,才会回退到缓存的账户邮箱。对于 YOUKA_API_KEY token,它不会使用缓存的 config 身份。
下一步
- 全局选项 - 每个命令共享的 flags
- 项目 - 创建并处理卡拉 OK 项目