Start with the CLI

Install on macOS or Linux

The installer selects the release for your platform, verifies its SHA256 checksum and binary version, and installs into your user directory. It does not edit your shell profile. Add the install directory to your shell's PATH if you want it available in new terminals.

installer="$(mktemp)" &&
curl -fsSL https://github.com/purrkey-ai/cli/releases/latest/download/install.sh -o "$installer" &&
bash "$installer" &&
rm -f "$installer" &&
export PATH="${ATX_INSTALL_DIR:-$HOME/.local/bin}:$PATH" &&
purrkey version

Install on Windows

The Windows installer updates PATH for the current session. Add %LOCALAPPDATA%\Purrkey\bin, or your chosen ATX_INSTALL_DIR, to your user PATH for new terminals.

If your execution policy blocks scripts, download the Windows ZIP from the release, verify SHA256SUMS and add the extracted executable to PATH.

$installer = Join-Path $env:TEMP ([guid]::NewGuid().ToString() + '.ps1')
try {
  Invoke-WebRequest https://github.com/purrkey-ai/cli/releases/latest/download/install.ps1 -OutFile $installer -ErrorAction Stop
  & $installer
  if (-not $?) { throw 'Purrkey installation failed' }
  purrkey version
} finally {
  Remove-Item $installer -ErrorAction SilentlyContinue
}

Save an API key

Create a key in the console, replace YOUR_API_KEY below, and run the complete command in your terminal. Purrkey verifies the key before saving it. On macOS and Linux, the saved file uses owner-only permissions. On Windows, access depends on your user-directory permissions; the CLI does not configure a private Windows ACL. For hidden input, run purrkey config.

purrkey keys add YOUR_API_KEY

Find and inspect a tool

Replace both placeholders with values returned by discovery. Read the input schema, price, limitations and delivery rules before creating a request.

purrkey discover --query 'public video comments' --limit 5
purrkey inspect --tool '<candidate toolId>' --revision '<toolRevision>'