Transform documents, specs, repositories, OCR text, Markdown, or natural language into complete, runnable, production-ready software projects in seconds.
|
|
- Python 3.10+
- Git
- 200MB disk space (Termux-friendly)
# Clone and setup
git clone https://github.com/Huynhthuongg/AGENTS.md.git
cd AGENTS.md
./scripts/setup.sh
./scripts/start.shOpen http://127.0.0.1:8000 in your browser or use the CLI:
# Plan a project
upca plan --text "# CRM Dashboard\nNeed auth, API, admin dashboard, dark mode"
# Compile & generate
upca compile --text "# CRM Dashboard\nNeed auth, API, admin dashboard" --output-dir generatedpkg update && pkg install python git
cd ~
git clone https://github.com/Huynhthuongg/AGENTS.md.git
cd AGENTS.md
./scripts/setup.sh
./scripts/start.shThis repository includes a Vercel serverless entrypoint and routing config, so the FastAPI dashboard is served at / instead of returning 404: NOT_FOUND.
# From the project root
vercelVercel uses:
vercel.jsonto route every request to the Python serverless function.api/index.pyas the FastAPI entrypoint.requirements.txtto install runtime dependencies.
curl -s http://127.0.0.1:8000/healthcurl -s -X POST http://127.0.0.1:8000/plan \
-H 'Content-Type: application/json' \
-d '{
"requirements": "# Portal\nNeed API, dashboard, auth and mobile responsive UI"
}'curl -s -X POST http://127.0.0.1:8000/compile \
-H 'Content-Type: application/json' \
-d '{
"requirements": "# E-commerce Store\nPython FastAPI backend, React frontend, PostgreSQL",
"output_dir": "generated"
}'AGENTS.md/
├── app/universal_compiler_agent/ # Main application package
│ ├── cli.py # CLI interface
│ ├── server.py # FastAPI server
│ ├── planner.py # Planning engine
│ └── compiler.py # Code generation
├── config/ # Configuration examples
├── docs/ # Architecture & specs
├── scripts/ # Setup & helpers
│ ├── setup.sh # Initial setup
│ ├── start.sh # Start server
│ ├── check.sh # Run tests & linters
│ └── backup.sh # Backup script
├── tests/ # Unit tests
├── .github/workflows/ # CI/CD pipelines
├── pyproject.toml # Project configuration
└── LICENSE # AGPL-3.0
# Install dev dependencies
python -m pip install -e '.[dev]'
# Run quality checks
./scripts/check.shThe check.sh script runs:
- 🔍 Ruff (linter)
- ✏️ Codespell (spell checker)
- ✅ Pytest (test suite)
| Property | Details |
|---|---|
| Version | 0.1.1 |
| Release Date | 2026-06-02 |
| Python | 3.10+ |
| License | AGPL-3.0-only |
| Status | ✅ Active Development |
- 🏃 CLI dry-run previews
- 📂 Safe output directory validation
- 🎛️ Dashboard route alignment
- 🧪 Hardened test workflows
We take security seriously:
- 🚫 No hardcoded secrets in generated output
- 🔍 Pattern detection redacts API keys, tokens, passwords
- 🛡️ Path validation prevents directory traversal attacks
- 🔒 HTTP headers follow security best practices
- ✅ AGPL-3.0 ensures transparency
- FastAPI (0.115+) - Web framework
- Uvicorn (0.30+) - ASGI server
- Pydantic (2.8+) - Data validation
- Pytest (8.0+) - Testing
- Ruff (0.6+) - Code linting
- Httpx (0.28+) - HTTP client
- Codespell (2.3+) - Spell checking
Become a sponsor and help us develop faster! Your support helps maintain and improve this project.
Your Company Here 🌟 Platinum Sponsor |
Support Us 🥈 Gold Sponsor |
Thanks to all our contributors! Your contributions make this project better every day.
Found a bug? Have a feature request? We'd love to hear from you!
This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0).
This means:
- ✅ You can use, modify, and distribute this software
- ✅ You must share your modifications if you use it
- ✅ You must include the original license
See LICENSE for full details.
