Agent Guides¶
Documentation for coding agents and developers using the CharlieHub infrastructure.
Quick Links¶
🚀 Getting Started¶
- Start Here - 2-minute quick navigation guide
- Perfect for first-time agents or when you're unsure where to begin
📚 Complete API Reference¶
- API Guide - Complete REST API documentation
- Includes curl examples, Python client library, and best practices
- Use this to learn how to do everything via the API
❓ Troubleshooting¶
- Troubleshooting Guide - Error explanations and solutions
- Got an error? Find your error number and see what to do instead
- 9 common errors with clear solutions
Quick Help¶
Just want quick help?
/opt/charliehub/agent-help
This command will: - Show your current setup - Test API connectivity - Point you to the right documentation
Key Principles¶
- Files are read-only by design - This prevents corruption
- Use the API for everything - It's the safe, validated way
- Documentation is your friend - Read the guides first
- All actions are logged - Nothing happens without a trace
For Different Needs¶
"I want to add a new domain"¶
→ Read: API Guide - Add a New Domain
"I got a permission denied error"¶
→ Read: Troubleshooting - Error 1
"I want to understand the API"¶
→ Read: API Guide - Why Files Are Read-Only
"I'm new and don't know where to start"¶
→ Read: Start Here
API Basics¶
All API calls need:
1. Host: http://172.19.0.5:8001
2. API Key: Set export DOMAIN_MANAGER_API_KEY="your_key"
3. Header: -H "X-API-Key: $API_KEY" and -H "Content-Type: application/json"
Example:
curl -H "X-API-Key: $API_KEY" http://172.19.0.5:8001/api/domains
Need Help?¶
- Quick help: Run
/opt/charliehub/agent-help - Got an error? Check Troubleshooting
- Learning the API? Read API Guide
- Getting started? Read Start Here
- Still stuck? Ask your team lead or DevOps engineer
Last updated: 2026-02-08