Getting Started

What is Augure?

Augure is an open-source personal AI agent designed to run continuously on a server. It connects to your messaging apps, learns your preferences over time, executes tasks proactively on a schedule, and can spin up isolated sandboxes for complex work.

The name comes from French/Latin for "oracle, the one who foresees." Augure anticipates your needs, acts proactively, and learns to foresee what you want.

Core Principles

• Filesystem-first -- Memory, config, logs: everything is files. Human-readable, git-trackable, greppable. No vector DB, no embeddings, no opaque stores.
• Readable -- Target under 10K lines of code. A single developer can audit the entire codebase in an afternoon.
• Secure by default -- All execution in Docker containers. Credentials never touch disk. No inbound ports required.
• Proactive -- Not just reactive chat. Schedules, monitors, and acts on your behalf 24/7 via cron jobs and heartbeat checks.
• Cost-aware -- Per-usage model routing. Cheap models for monitoring and ingestion, full models for reasoning.
• Self-improving -- Extracts observations from conversations, generates reusable skills (code + tests), and auto-heals broken skills via LLM-powered self-repair.

Quick Start

Prerequisites

• An OpenRouter API key
• A Telegram Bot Token
• Docker installed (required for sandbox execution)
• Node.js 22+ (for npm install method)

Option A -- Install via npm (recommended)

npm install -g augure
augure init        # generates augure.json5 + .env in the current directory
# Edit .env with your API keys
# Edit augure.json5 with your preferences
augure start

Option B -- Docker Compose

For a fully containerized setup on a VPS:

git clone https://github.com/FaureAlexis/augure.git
cd augure

cp .env.example .env
# Edit .env with your tokens:
#   OPENROUTER_API_KEY=sk-or-...
#   TELEGRAM_BOT_TOKEN=123456:ABC...

cp config/augure.example.json5 config/augure.json5
# Edit config with your preferences (no secrets here!)

docker compose up -d

Talk to your bot on Telegram

No ports to open, no firewall to configure. The agent uses outbound polling only.

What's Next

• Configuration Reference -- understand every option in augure.json5
• Architecture -- how the agent works internally
• Channels -- messaging platform integrations (Telegram, etc.)
• Memory System -- how Augure learns and remembers
• Skills System -- self-generated skills with auto-healing
• Scheduler -- cron jobs and proactive heartbeat
• Tools -- native tools available to the agent
• Deployment -- production setup and security