QUICK START GUIDE

aikey 快速开始

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

PERSONAL SCENARIOS

先从你遇到的问题开始

如果你只是想把本机 AI 工具先跑顺,不必从概念开始读。下面这些场景对应每天最常见的 Key、OAuth、额度、账单和 Agent 授权问题。

LOCAL AGENT OAUTH GRANT

第三方 Agent 想用 Key,但真实 Key 不能交出去

用户在 AiKey Web 选择一个虚拟 Key,通过 OAuth 授权给本地 Agent。Agent 拿到的是可撤销入口,真实凭证仍留在 Vault,后续可以按 Agent 查看用量和调用摘要。

SELECT VK
OAUTH GRANT
LOCAL AGENT
OAuth Account

不碰 token,只授权本机工作流

没有 AiKey 前

token 被复制到环境变量、JSON 配置、脚本、浏览器页面或第三方客户端,过期和泄漏都很难追。

AiKey 介入后

Provider OAuth 账号进入本地 Vault,日常工具只看到 AiKey 本地入口或 active binding。

下一步

进入「使用 OAuth 账号」:aikey auth login claude

Connectivity

登录成功以后,先确认这条链路真的能跑

PING(D)
PROXY
API
CHAT

场景页把「登录完成」和「本机工具能发起 chat」拆开讲清楚。测试失败时,凭证可以先保存,再按提示排查下一步。

Route Token

额度耗尽时,换的是背后账号,不是当前任务

用户要保住当前 Claude Code / Cursor / Codex 会话。AiKey 用稳定 route token 接住工具入口,背后真实凭证可以通过 aikey use backup-account 切换。

查看 route token 与第三方客户端配置
CURRENT TASK
ACTIVE BINDING
BACKUP
Cost & Trust

账单不再只是月底的一串总额

用户每天在多个 AI 工具间切换,最需要的是这次会话花了什么、cache 有没有命中、模型返回有没有可疑信号,而不是事后再去云 dashboard 里翻。

input/output token cache hit model source signal
Usage Receipt
ProviderAnthropic
Modelopus-4-7
Cachemiss
Trustneeds review
ESTIMATE$0.42
Local Agent Grant

Agent 可以调用,但真实 Key 不离开 Vault

01

Web 选择虚拟 Key

用户选择允许 Agent 使用的 route token,不选择真实凭证。

02

OAuth 授权

授权给本地 Agent 的是可撤销入口,不是明文 KEY。

03

本地调用

Agent 走 AiKey 本地入口,真实 provider key 仍由 Vault 托管。

04

撤销与统计

按 Agent 撤销访问,按 token / provider / model 查看用量。

macOS / Linux 安装

最新稳定版(推荐 —— 自动解析最新 GA tag):

curl -fsSL https://aikeylabs.com/zh/i/of | 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/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 状态

常见问题排查

装完立刻 aikey: command not found

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

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

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

aikey-proxy.exe 升级报 file in use

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