Pickaxe CLI

---

What is the Pickaxe CLI?

The Pickaxe CLI is a small tool that lets AI coding agents — like Claude Code, Codex, or Cursor — make changes directly to your Pickaxe account. You describe what you want in plain English, and the coding agent uses the CLI to do the work for you. No coding required on your end.

---

Using it with coding agents like Claude Code

Getting set up

You only need to install and authenticate once. Open your terminal (on Mac, press ⌘ + Space and type "Terminal") and run:

npm install -g @pickaxe/pickaxe-cli

Then grab a workspace API key from your Pickaxe workspace settings and run:

pickaxe auth login --api-key YOUR_WORKSPACE_API_KEY

That's it — your coding agent can now talk to your Pickaxe account. From here, open Claude Code (or Codex, Cursor, etc.) in a folder of your choice and say something like:

"Use the Pickaxe CLI to pull down my workspace so we can start making changes."

The coding agent will run the right commands, pull a local copy of your agents, deployments, and documents, and be ready for you to give it instructions in plain English.

---

Use cases

Once you're connected, your coding agent can handle almost any account task for you. A few ideas:

• Set up multiple agents and deployments at once. Ask for several agents — each with its own prompt, knowledge base, and embed — all in a single conversation.
• Style your agents and portals. Have your coding agent write and inject custom code into your deployment. For example: "Style my agent so it looks like an iMessage chat — blue bubbles for the user, grey bubbles for the agent." You can match your brand, add animations, or theme a portal for a specific campaign, all by describing the vibe you want.
• Manage users, documents, actions, and access groups in bulk. Bulk-add users to a member access group, upload a batch of knowledge base documents, update actions across multiple agents, or clean up inactive accounts — all with natural language instructions.
• Work through changes conversationally. Instead of clicking through the dashboard, just tell your agent what you want and review what it's about to do before it goes live.

A quick tip: always take a look at what your coding agent is about to do before approving changes that affect live agents or real users.

---

Learn more

Want to dig deeper? Our CLI & Coding Agents documentation has more details on authentication, workflows, and the kinds of tasks you can hand off to a coding agent.