Get Started
CLI & Coding Agents
Use the Pickaxe CLI with Claude Code, Codex, Cursor, and other coding agents.
If you are working with Claude Code, Codex, Cursor, or another coding agent, you can simply tell it to use the Pickaxe CLI to manage your workspace instead of calling these endpoints by hand.
Install
pnpm add -g @pickaxe/pickaxe-cli
You can also install it with npm:
npm install -g @pickaxe/pickaxe-cli
Authenticate
pickaxe auth login --api-key YOUR_WORKSPACE_API_KEY
pickaxe whoami
Good Agent Workflows
pickaxe init,pickaxe pull,pickaxe diff, andpickaxe pushfor syncing a Pickaxe project locally.pickaxe docs add|list|removefor knowledge base documents.pickaxe users ...,pickaxe memory ..., andpickaxe access-groups ...for workspace operations.pickaxe deploy createfor deployment creation.pickaxe doctorfor checking auth and project setup.
