AiKey Docs - Personal Edition

Install

macOS / Linux

Run the stable one-liner to auto-detect and install the latest release.

BASH / ZSH

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

To skip prompts in CI: curl ... | sh -s -- --yes

Windows (PowerShell)

Stage 4 windows-compat. Works in PowerShell 7+ or 5.1. Hardens NTFS ACL to owner-only for vault security.

POWERSHELL

$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"

After install, run aikey hook install for PowerShell auto-activation.

Use Your Own API Key

Add keys to the local encrypted vault and activate them for your session.

Add & Activate

aikey add my-key aikey use my-key

CLI Integration

claude codex kimi

OAuth Accounts

Log in directly via OAuth for subscription-based access without explicit API keys.

aikey auth login claude # Claude (Anthropic)

aikey auth login codex # Codex / ChatGPT (OpenAI)

aikey auth login kimi_code # Kimi Code

Web Console & My Vault

View key status, usage, and manage your credentials through a secure local browser interface.


                  aikey web

My Vault: Lists every personal API key and OAuth account. Lets you rename, reveal (60s timer), or delete keys. OAuth tokens are never revealed in the browser for security.

Use Team Keys

If your admin has created team keys in the control panel:

aikey login # Log in via browser aikey use # Pick a key (arrow keys + Enter)

CI / Scripts

Works with GitHub Actions, cron jobs, and non-interactive scripts. No shell hook required.


                  aikey run -- python eval.py

Daily Commands

aikey list

View all keys in vault

aikey use

Switch active key

aikey whoami

Identity + active key

aikey doctor

One-click health check

Connectivity Test

Verify credentials by running the full probe sequence: Ping(D) → Ping(proxy) → API → Chat.

aikey test # Active bindings only aikey test --all # Probe every credential in vault

Temporary Key Switching

Use aikey activate to switch keys in the current terminal only. Closing the terminal reverts everything.

aikey activate my-key

# To restore global settings:

aikey deactivate

Third-Party AI Clients

Configure Cursor, Continue, or OpenCode via custom base_url.

1. Get Route Config

aikey route my-key

  base_url:  http://127.0.0.1:27200/anthropic
  api_key:   aikey_vk_b82ef1d49c3a7e08...

opencode.jsonc

{
  "provider": {
    "anthropic": {
      "options": {
        "baseURL": "http://127.0.0.1:27200/anthropic/v1",
      }
    }
  }
}

Troubleshooting

Quick Fixes

aikey doctor
aikey proxy restart
aikey key sync

Symptom (Windows)	Fix
EACCES on hook.ps1	Close other PowerShell windows, then re-run without elevation.
Command not found	Open a fresh terminal to load updated PATH.
Upgrade in-place fails	Run `aikey proxy stop` before installing.