主题
为当前环境做身份认证并管理配置档。配置档里保存着控制面 API URL、项目,以及可选的 API key。
用量
终端窗口
llamactl auth [COMMAND] [options]命令:
token [--project PROJECT] [--api-key KEY]:用 API key 创建配置档;校验 token 并选定一个项目login:通过网页浏览器登录(OIDC 设备码流程)并创建配置档get [NAME] [-o text|json|yaml]:列出当前环境的配置档,或查看某个配置档use [NAME]:设置当前配置档logout [NAME]:删除配置档及其本地凭据inject [--env-file PATH]:把配置档凭据写入.env文件
请注意:
- 配置档会按当前环境过滤(
llamactl environments use)。 - 当
--api-key与--project都给出时,auth token无需任何提示即可创建配置档。 - 项目选择已移到
llamactl projects use。 - 组织列表已移到
llamactl organizations get。
命令
Token
终端窗口
llamactl auth token [--project PROJECT] [--api-key KEY]不带选项时,会提示输入 API key、通过列出项目来校验它,然后让你选择一个项目。它会创建一个自动命名的配置档并设为当前。
同时给出 --api-key 与 --project 时,无需提示即可创建配置档。
示例:
终端窗口
llamactl auth token --api-key llx-... --project your-project-idLogin
终端窗口
llamactl auth login通过浏览器用 OIDC 设备码流程登录、选择一个项目,并创建一个设为当前的登录配置档。
Get
终端窗口
llamactl auth get [NAME] [-o text|json|yaml]显示当前环境的配置档。传入 NAME 则只看那一个配置档。
Use
终端窗口
llamactl auth use [NAME]设置当前配置档。在终端里省略 NAME 时,可从可用配置档中选择。脚本应当显式传入 NAME。
Logout
终端窗口
llamactl auth logout [NAME]删除一个配置档。如果被删的正是当前配置档,当前选择会被清空。
Inject
终端窗口
llamactl auth inject [--env-file PATH]把当前配置档中的 LLAMA_CLOUD_API_KEY、LLAMA_CLOUD_BASE_URL 与 LLAMA_AGENTS_PROJECT_ID 写入一个 .env 文件。文件不存在则创建;已有的值会被覆盖。
环境变量
llamactl 也可以用环境变量而非存储的配置档来认证。这对 CI、自动化脚本,以及不方便执行 llamactl auth login 的环境很有用。
| 变量 | 是否必填 | 默认值 | 说明 |
|---|---|---|---|
LLAMA_CLOUD_API_KEY | 是 | — | 用于认证的 API key |
LLAMA_AGENTS_PROJECT_ID | 是(对项目级命令而言) | — | 要操作的项目 |
LLAMA_CLOUD_BASE_URL | 否 | https://api.cloud.llamaindex.ai | 控制面 API URL |
LLAMA_CLOUD_USE_PROFILE | 否 | false | 设为 1 则忽略环境变量、改用存储的配置档 |
当 LLAMA_CLOUD_API_KEY 与 LLAMA_AGENTS_PROJECT_ID 都已设置时,llamactl 会直接使用它们并跳过配置档查找。如果同时也存在存储的配置档,会往 stderr 打印一条警告;把 LLAMA_CLOUD_USE_PROFILE=1 设上即可回到基于配置档的认证。
--project 选项总是优先于 LLAMA_AGENTS_PROJECT_ID。
示例:
终端窗口
export LLAMA_CLOUD_API_KEY="llx-..."
export LLAMA_AGENTS_PROJECT_ID="your-project-id"
llamactl deployments get或者用 llamactl auth inject 从当前配置档生成一个 .env。