Skip to main content

Documentation

Guides, references, and resources for running your own AI agent on Algorand.

Type to filter by title, description, or filename — press / to focus

🚀

Getting Started

Quickstart
Get up and running in minutes. Install, configure, and launch your first agent.
quickstart.md
🧠
How It Works
Understand the architecture, agent lifecycle, and how tasks flow from issue to PR.
how-it-works.md
💻
System Requirements
Hardware, software, and OS prerequisites for running corvid-agent.
system-requirements.md
⚙️
Configuration
Environment variables, config files, and all available settings.
configuration.md
🔧
Troubleshooting
Common issues, debugging steps, and known fixes.
troubleshooting.md
📖

Guides

💡
Use Cases
Real-world examples and workflows for different team sizes and project types.
use-cases.md
💼
Business Guide
ROI analysis, cost breakdowns, and talking points for stakeholders.
business-guide.md
🏢
Enterprise Guide
Compliance, governance, and scaling corvid-agent across teams.
enterprise.md
🖥️
Self-Hosting / Deployment
Deploy to your own infrastructure with Docker, VPS, or bare metal.
self-hosting.md
🔌
MCP Setup
Connect corvid-agent as an MCP server for Claude Code, Cursor, and other tools.
mcp-setup.md
⛓️
Algorand Testnet Onboarding
Set up a testnet wallet, fund it from the faucet, and connect to AlgoChat.
testnet-onboarding.md
💭
Project Ideas
Starter projects and inspiration for what to build with your agent.
project-ideas.md
🎵
VibeKit Integration
Integrate with VibeKit for extended agent capabilities and tooling.
vibekit-integration.md
📚

Reference

🌐
API Reference
Complete REST API documentation with endpoints, parameters, and examples.
api-reference.md
📟
CLI Reference
All CLI commands, flags, and usage patterns.
cli-reference.md
🔬
Technical Deep Dive
Internals, implementation details, and advanced architecture notes.
deep-dive.md
🛡️

Security

🔒
Hardening Guide
Security best practices for locking down your production deployment.
hardening-guide.md
🎯
Threat Model
Attack surface analysis, risk assessment, and mitigation strategies.
threat-model.md
🚨
Incident Response
Playbooks for breach detection, containment, and recovery.
incident-response.md
📁

Project

🤝
Contributing Guide
How to contribute: code style, PR process, and development setup.
CONTRIBUTING.md
🛡️
Security Policy
How to report vulnerabilities and our responsible disclosure process.
SECURITY.md
🔭
Project Vision & Roadmap
Long-term goals, project direction, and what's coming next.
VISION.md
🔍

No docs match your search. Try a different term.