CLI & 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, and pickaxe push for syncing a Pickaxe project locally.
• pickaxe docs add|list|remove for knowledge base documents.
• pickaxe users ..., pickaxe memory ..., and pickaxe access-groups ... for workspace operations.
• pickaxe deploy create for deployment creation.
• pickaxe deploy update for pushing new headerScript and footerScript injection code to an existing embed or direct-link deployment.
• pickaxe deploy snippet for rendering the final local embed HTML, including injected header and footer files.
• pickaxe page create, pickaxe page update, and pickaxe page link for custom coded pages and page-to-portal navigation.
• pickaxe portal create, pickaxe portal update, and pickaxe portal styling list for portal setup and styling token discovery.
• pickaxe doctor for checking auth and project setup.

Embed Injection Example

deployments:
  - key: website
    type: embed-script-inline
    headerScriptFile: embeds/header.html
    footerScriptFile: embeds/footer.html

pickaxe deploy create --key website
pickaxe deploy update --key website --header-script-file embeds/header.html
pickaxe deploy snippet --key website

Useful Links

• Pickaxe CLI overview
• npm package: @pickaxe/pickaxe-cli