Quickstart Guide

Get Vagus running locally in minutes with our development environment

Prerequisites

Before getting started, ensure you have the following installed:

  • Rust: Latest stable version (curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh)
  • Foundry: Ethereum development toolkit (curl -L https://foundry.paradigm.xyz | bash)
  • Python 3.8+: With pip package manager
  • Docker: For containerized development (optional)
  • Git: Version control system

System Requirements

Minimum hardware requirements for development:

  • RAM: 8GB minimum, 16GB recommended
  • Storage: 10GB free space
  • OS: Linux/macOS (Windows via WSL)
  • Network: Stable internet connection

Note: ARM64 Macs are supported via Rosetta or native builds.

Step-by-Step Setup

Follow these steps to get a complete Vagus development environment running

1. Clone the Repository

git clone https://github.com/Beijing-Datoms-Technology-Corp/vagus.git
cd vagus

2. Start Local Development Network

./infra/anvil.sh

This will start a local Ethereum testnet with Vagus smart contracts already deployed.

3. Run an Example

# In a new terminal
cd planner
python -m venv venv
source venv/bin/activate  # Windows: venv\Scripts\activate
pip install -r requirements.txt
python examples/basic_agent.py

πŸŽ‰ Congratulations!

You now have a running Vagus agent system. Check the terminal output to see what happened.

Next Steps: Check out our documentation for more advanced usage.