QUICK START GUIDE

aikey 快速开始

通过本地加密 Vault 管理你的 AI 凭证。本指南涵盖了从一键安装到多账号治理的所有核心流程。

macOS / Linux 安装

最新稳定版（推荐 —— 自动解析最新 GA tag）：

curl -fsSL https://github.com/aikeylabs/launch/releases/latest/download/latest-install.sh | sh

安装目录为 ~/.aikey/bin。

Windows 安装 (PowerShell 原生)

最低支持 Windows 10 1809+ / Windows 11。支持 PowerShell 7+ 或 Windows PowerShell 5.1。

# 下载 installer 包，解压并运行
$Tag  = (Invoke-RestMethod "https://api.github.com/repos/aikeylabs/launch/releases/latest").tag_name
$Bare = $Tag.TrimStart('v')
iwr "https://github.com/aikeylabs/launch/releases/download/$Tag/aikey-installer-windows_${Bare}.zip" -OutFile "$env:TEMP\aikey-inst.zip"
Expand-Archive -Path "$env:TEMP\aikey-inst.zip" -DestinationPath "$env:TEMP\aikey-inst" -Force
& "$env:TEMP\aikey-inst\local-install.ps1"

安装后如需自动激活 shell，请执行：aikey hook install

使用个人 API Key

将你的 API Key 添加到本地加密 vault。

1. 添加并激活 Key

aikey add my-key
aikey use my-key

2. 直接使用常用工具

本地代理会自动注入 Key，无需暴露真实凭证。

claude

codex

kimi

使用 OAuth 账号

如果你有 Claude Pro/Max、ChatGPT Plus 等订阅，可以直接登录使用：

Claude (Anthropic)

aikey auth login claude

Codex / ChatGPT

aikey auth login codex

Kimi Code

aikey auth login kimi_code

Web 控制台

aikey web

使用团队 Key

适用于管理员已在控制台创建并分配好的场景。

aikey login          # 登录并授权
aikey use            # 选择 Key (上下箭头 + 回车)

CI / 脚本集成 (无交互)

不依赖 shell hook，适合 GitHub Actions 或定时任务。

aikey run -- python eval.py

测试 Key 连通性

每行依次跑 Ping(D) → Ping(代理) → API → Chat 四阶探测。

aikey test 当前已激活的 Primary 逐个体检

aikey test my-key 指定 Key 各协议全量自检

aikey test --all Vault 内所有 Key 全量体检

临时切换 Key

在当前终端临时激活，关闭终端即失效，不修改全局设置。

aikey activate my-key       # 在当前终端激活
aikey deactivate            # 立即恢复全局设置

在第三方 AI 客户端中使用

查看指定 Key 的路由 token 配置：

aikey route my-key

OpenCode 示例配置

{
  "provider": {
    "anthropic": {
      "options": {
        "baseURL": "http://127.0.0.1:27200/anthropic/v1",
      }
    }
  },
  "model": "anthropic/claude-opus-4-7"
}

日常操作速查

aikey whoami

查看当前身份和当前 Key

aikey doctor

一键自检常见问题

aikey list

列出所有可用的 Key

aikey key sync

强制同步 Key 状态

常见问题排查 (Windows 专属)

装完立刻 aikey: command not found

新 PATH 只在新开的窗口生效。请尝试重启终端。

运行 aikey use 后没看到提示符变化

PowerShell hook 未安装。请执行 aikey hook install。

aikey-proxy.exe 升级报 file in use

先关闭 proxy：aikey proxy stop，如有残留请强杀旧进程。