-
Notifications
You must be signed in to change notification settings - Fork 7
For Humans
A non-technical guide to understanding and using the AI DevOps Framework.
Before this framework:
- AI assistants had to figure out your infrastructure from scratch each time
- Instructions were scattered across multiple files
- No consistent way to handle credentials securely
- AI might create files randomly in your home directory
After this framework:
- AI assistants have comprehensive knowledge of 30+ services
- One authoritative instruction file (
AGENTS.md) - Secure credential management built-in
- Organized working directories
You: "Help me deploy my site to Hostinger"
AI: *reads AGENTS.md*
*reads .agent/hostinger.md*
*uses hostinger-helper.sh*
AI: "I'll help you deploy. First, let me verify your account..."
The AI knows:
- What Hostinger is and how to use it
- Where to find configuration
- What commands are available
- Security requirements
| Category | Services |
|---|---|
| Hosting | Hostinger, Hetzner, Cloudflare, Vercel |
| Domains | Spaceship, 101domains, Namecheap |
| Code Quality | Codacy, CodeRabbit, SonarCloud |
| WordPress | MainWP, LocalWP integration |
| Security | Vaultwarden, Snyk |
Pre-built processes for:
- Starting new features
- Fixing bugs
- Releasing versions
- Code reviews
- CI/CD monitoring
Ready-to-use scripts for:
- Service management
- Quality checks
- API key setup
- Deployment tasks
git clone https://github.com/marcusquinn/aidevops.git ~/git/aidevopsWhen working on DevOps tasks, tell your AI assistant:
"Read ~/git/aidevops/AGENTS.md for guidance"
That's it! Your AI now knows about all the services and how to use them.
Your AI will:
- Ask which provider (Hostinger, Hetzner, etc.)
- Guide you through configuration
- Use the appropriate helper scripts
- Set up securely
Your AI will:
- Run quality checks (Codacy, SonarCloud, etc.)
- Report issues found
- Suggest or apply fixes
- Verify improvements
Your AI will:
- Check your hosting configuration
- Handle the deployment
- Verify it's working
- Set up any needed DNS
Your AI will:
- Create the repo with proper settings
- Set up branch protection
- Configure CI/CD workflows
- Add appropriate templates
The framework handles security automatically:
- API keys are stored securely (not in Git)
- Credentials are never exposed in logs
- Destructive operations require confirmation
- Files are created in organized directories
| File | What It Does |
|---|---|
AGENTS.md |
Main instructions for AI assistants |
.agent/ folder |
All documentation and scripts |
~/.aidevops/.agent-workspace/ folder |
Your personal working directory |
No! Just clone the repo and tell your AI assistant about it. The AI reads the documentation when needed.
No. The framework creates files only in organized directories (~/.aidevops/.agent-workspace/work/, etc.), never randomly in your home folder.
Yes, but always:
- Review what the AI is doing for destructive operations
- Use test environments first when possible
- Keep your API keys secure
Yes! Any AI assistant that can read files can use this framework. Just point them to AGENTS.md.
The framework includes troubleshooting guides and the AI can check service status pages automatically.
- Issues: GitHub Issues
- Documentation: Browse the wiki pages
- Source Code: GitHub Repository
- Getting Started - Technical setup guide
- Understanding AGENTS.md - How AI guidance works
- Workflows Guide - Development processes