Quickstart
Build and run an agent in under 2 minutes.
Install the Pickaxe CLI
The Pickaxe CLI is a command line interface for quickly getting started with Pickaxe by scaffolding a new agent project:
First, install the Pickaxe CLI:
Then create a new agent:
Then cd into the agent directory and install dependencies:
First, install the Pickaxe CLI:
Then create a new agent:
Then cd into the agent directory and install dependencies:
First, install the Pickaxe CLI:
Then create a new agent:
Then cd into the agent directory and install dependencies:
First, install the Pickaxe CLI:
Then create a new agent:
Then cd into the agent directory and install dependencies:
Generate a Hatchet API token
Pickaxe requires a Hatchet API token for orchestration. You can generate a Hatchet token by signing up for a free account on Hatchet Cloud or following instructions for self-hosting Hatchet.
Add this API token to the .env file in the project:
Set your LLM API key
Add this API token to the .env file in the project:
Run your agent
The default pickaxe agent is a simple deep research agent that can be triggered to perform a deep research task. It uses the OpenAI API to generate responses and the Hatchet API to orchestrate the agent’s execution. For a full walkthrough of this agent, see the deep research example.
To start your agent, you can run the following:
To trigger the agent, in a separate terminal you can run:
This will prompt you for a deep research prompt and then execute the agent.