Complete documentation for understanding and using AutoResearch.
Start here in this order:
-
../README.md (5 min read)
- What is AutoResearch?
- Quick navigation
- Key features overview
-
../CONCEPTS.md (20 min read)
- Core ideas explained clearly
- What is semantic linking?
- What is constraint-theory validation?
- What is cold storage?
- What is flowstate mode?
-
../install/INSTALLATION_GUIDE.md (15 min setup)
- Step-by-step installation
- Configuration wizard walkthrough
- Troubleshooting guide
Deep dives into architecture and design:
-
../ARCHITECTURE.md (60 min read)
- 7-layer system architecture
- Complete data flows
- Integration with SuperInstance ecosystem
- Fact-checking pipeline details
- Cold storage system
-
../INTEGRATION_GUIDE.md (45 min read)
- How to use each SuperInstance component
- spreader-tool orchestration
- murmur wiki integration
- constraint-theory validation
- spreadsheet-moment monitoring
How to run and manage the system:
-
- Installation quick start
- Configuration files generated
- Environment validation
-
- Configuration file structure
- Agent profiles (YAML)
- Service templates (pre-commented)
- Data retention policies
- How to customize
-
- Agent system overview
- Running agents
- Interacting with agents (chat, focus, priority)
- Real-time monitoring
- Creating custom agents
-
- Docker setup and usage
- Multi-service orchestration
- GPU support configuration
- Troubleshooting containers
-
- Understanding experiment results
- Analyzing metrics
- Knowledge graph exports
- Podcast content generation
- Data retention and cold storage
├── README.md # Start here!
├── CONCEPTS.md # Understand the ideas
├── ARCHITECTURE.md # Technical deep dive
├── INTEGRATION_GUIDE.md # Connect components
│
├── install/
│ ├── README.md # Quick installation
│ └── INSTALLATION_GUIDE.md # Detailed setup
│
├── config/
│ └── README.md # Configuration guide
│
├── agents/
│ └── README.md # Agent system
│
├── docker/
│ └── README.md # Container deployment
│
├── results/
│ └── README.md # Results and outputs
│
└── docs/
└── README.md # You are here
- ../README.md - Overview
- ../install/INSTALLATION_GUIDE.md - Get it running
ar start --agents 1- Launch agentsar chat default- Talk to agent
Result: You have AutoResearch running!
- ../CONCEPTS.md - Core ideas
- ../ARCHITECTURE.md - System design
- ../config/README.md - Configuration
- ../agents/README.md - Agents
Result: You understand how everything works
- ../docker/README.md - Containers
- ../INTEGRATION_GUIDE.md - SuperInstance integration
- ../results/README.md - Results management
- Production setup with PostgreSQL, Redis, monitoring
Result: Enterprise-ready deployment
- ../config/README.md - Configuration
- ../agents/README.md - Custom agents
- Create custom agent profiles
- Define research objectives
- Monitor and iterate
Result: Autonomous research running 24/7
- Installation Guide - Step-by-step setup
- Installation README - Quick reference
- Docker Setup - Containerized deployment
- Config Guide - Complete configuration
- API Services - Service templates
- Agent Profiles - Agent configurations
- Agent System - How agents work
- CLI Commands - Command reference
- Monitoring - Track progress
- CONCEPTS.md - Core ideas
- ARCHITECTURE.md - System design
- INTEGRATION_GUIDE.md - SuperInstance integration
- Results README - Understanding outputs
- Data Format - Metrics structure
- Analysis Tasks - Example queries
Answer: Start with ../README.md, then follow INSTALLATION_GUIDE.md
Answer: See ../README.md - Python 3.10+, 8GB RAM, 250GB disk
Answer: Depends on API services:
- OpenAI: ~$2-5/hour per agent
- Local models (Ollama): Free
- Anthropic: Similar to OpenAI
Answer: Yes! See ../config/services/local-services.yaml
Answer: See ../config/README.md
Answer: Each experiment is exactly 5 minutes (fixed time budget)
Answer: In results/experiments/ directory. See ../results/README.md
Answer: Yes, but CPU-only mode is slow. See ../install/INSTALLATION_GUIDE.md
Answer: Configure in ../config/system.yaml or ../config/README.md
- SuperInstance GitHub
- SuperInstance Papers - 65+ research papers
- murmur - Semantic Wiki
- spreader-tool - Multi-agent Orchestration
- constraint-theory - Deterministic Validation
- OpenAI API
- Anthropic Claude
- Ollama - Local LLMs
- vLLM - Fast local inference
All documentation follows these principles:
- Clear: Use simple language, examples for complex concepts
- Complete: Answer common questions, include troubleshooting
- Current: Updated with latest features and best practices
- Consistent: Same style and structure across all docs
- Linked: Cross-references to related sections
Help us improve documentation:
- Found an error? File an issue on GitHub
- Want to add clarification? Submit a PR
- Have a tutorial? Share it with the community
- Found a gap? Let us know what's missing
- Main README - Start here
- CONCEPTS - Core ideas explained
- ARCHITECTURE - Technical design
- INTEGRATION_GUIDE - SuperInstance integration
- Install README - Quick reference
- INSTALLATION_GUIDE - Detailed setup
- Config README - Configuration guide
- Agents README - Agent system
- Docker README - Container setup
- Results README - Results analysis
- Docs README - This file
Choose your path:
New User? → Start with ../README.md
Ready to Install? → Follow ../install/INSTALLATION_GUIDE.md
Want to Understand? → Read ../CONCEPTS.md
Ready to Run? → See ../agents/README.md
Need Help? → Check documentation index above or file GitHub issue
Happy learning! 🚀
Last updated: March 17, 2026