Skip to content

Quick Start

Get up and running with Aurite in just a few minutes!

1. Install Aurite

  • Set up Python 3.12+ and a virtual environment.
  • Install the aurite package: 
    pip install aurite

Need more details?

See the Package Installation Guide for step-by-step instructions.

2. Initialize Your Workspace & Project

Run the interactive wizard from your chosen directory:

aurite init

This creates your workspace, first project, and example configurations.

Learn More

For details on projects and workspaces, see Projects and Workspaces.

3. Run a Built-In Agent

Try out the Weather Agent with a single command:

aurite run "Weather Agent" "Weather in London?"
Example Output 
  The weather in London is currently 15°C, rainy, with 90% humidity.

Next Steps

  • Explore more CLI commands in the CLI Reference.
  • Edit configurations with: 
    aurite edit
  • Start the API server: 
    aurite api

Ready to build?

You're set to start building with Aurite. Dive into configuration and workflow customization to unlock advanced features!