Getting Started

Install Augy and run your first backtest in minutes.

Prerequisites

Install from source

$ git clone https://github.com/augydev/augy.git

$ cd augy

$ npm install

$ npm run tauri:dev

This starts Augy in development mode. For a production build, run npm run tauri:build instead.

First launch

When you first open Augy, a few things are set up automatically:

  • A sample BTC-USD dataset (2,160 hourly bars / 90 days) is pre-loaded so you can start backtesting immediately.
  • The local SQLite database is created to store your agents, backtests, datasets, and settings.
  • No API keys are required to get started. You can create agents and run backtests against the sample data right away.

Quick start workflow

  1. 1
    Configure API keys (optional) -- Head to Settings to add your LLM and market data provider keys.
  2. 2
    Import data -- Go to Datasets to import a CSV or fetch data from a provider, or use the pre-loaded sample data.
  3. 3
    Create an agent -- Open Agents and pick a template or start from scratch.
  4. 4
    Run a backtest -- Click "Backtest" in the agent editor, choose your dataset and config, and see how your strategy performs. See Backtesting for details.
Configuration →