AI handles the tedium. You focus on the craft.
CI / CD
|
|
Quality
|
|
Security
|
|
Community
|
|
🚀 Installation
|
⚡ Quick Start
|
📚 Features
|
📖 Documentation
|
🔐 Security
|
🛠️ Code Standards
|
🤖 AI Guidelines
|
👥 Maintainers
|
🤝 Contributing
|
📝 License
|
||
ATLAS requires a supported release of Go.
go install github.com/mrz1836/atlas@latestgit clone https://github.com/mrz1836/atlas.git
cd atlas
go build -o bin/atlas .ATLAS uses a workspace-based workflow. Each task runs in an isolated Git worktree with its own checkpoint-driven lifecycle.
atlas start "Fix race condition in cache handler" --type bugATLAS creates a worktree, analyzes the codebase, generates an implementation plan, and waits for your approval.
atlas statusShows all active workspaces and their current states. When a workspace is waiting for approval:
atlas approve ws-fix-race-condition-20260214-1447ATLAS executes the plan, runs linters and tests, fixes issues automatically, and submits for final review when ready.
atlas start "Add metrics endpoint" --type feature
atlas start "Update README examples" --type task
atlas statusEach workspace operates independently. You can approve, review, or abandon them in any order.
atlas review ws-fix-race-condition-20260214-1447Opens the workspace for inspection. When satisfied:
atlas merge ws-fix-race-condition-20260214-1447ATLAS merges the changes back to your main branch and cleans up the worktree.
📖 For complete command reference and workflow details, see the Quick Start Guide →
- Spec-Driven Development (SDD): Every task starts with analysis and planning
- Multi-Model Support: Claude Opus, Sonnet, Haiku, Gemini, GPT-4
- Context-Aware: ATLAS analyzes your codebase structure before making changes
- Iterative Refinement: Auto-fixes lint and test failures until clean
- Isolated Worktrees: Each task runs in its own Git worktree
- Independent Lifecycles: Start, approve, review, and merge tasks in any order
- No Branch Pollution: Clean separation between your main branch and WIP tasks
- Human-in-the-Loop: ATLAS stops at critical decision points
- Plan Review: Approve implementation plans before execution
- Final Review: Inspect completed work before merging
- Full Transparency: Every step is logged and reviewable
- Go Validation Protocol: Automatic pre-commit hooks, formatting, linting, testing
- Race Detection: Runs tests with
-raceflag to catch concurrency issues - CI Integration: Validates changes against your existing CI pipeline
- Coverage Tracking: Monitors test coverage across changes
- Minimal Configuration: Works out-of-the-box for Go projects
- Status Dashboard: Real-time view of all active workspaces
- Clean Git History: Commits are well-formed and descriptive
- Resume Support: Pick up interrupted work exactly where you left off
View the comprehensive documentation for ATLAS:
| Document | Description |
|---|---|
| templates.md | Template system reference and step types |
| quick-start.md | Complete CLI reference and workflow guide |
Heads up! ATLAS is experimental software under active development. The MVP focuses on Go projects with a spec-driven workflow. Support for other languages and frameworks is planned.
⚠️ Experimental Software — Use with CautionATLAS is experimental, open-source software provided "AS-IS" without warranty. By using ATLAS, you acknowledge:
- AI-Generated Code: All code changes are generated by AI models and should be reviewed carefully
- Git Worktrees: ATLAS creates and manages Git worktrees automatically—ensure you understand worktree behavior
- No Formal Audit: This software has not undergone professional security auditing
- Execution Risk: ATLAS runs commands (linters, tests, formatters) in your repository
- API Keys Required: You must provide your own API keys for AI model access
- No Liability: Authors accept no responsibility for data loss, corrupted repositories, or other damages
Always review AI-generated code before merging. Always commit your work before running ATLAS.
For security issues, see our Security Policy or contact: [email protected]
Development Setup (Getting Started)
Install MAGE-X build tool for development:
# Install MAGE-X for development and building
go install github.com/magefile/mage@latest
go install github.com/mrz1836/go-mage/magex@latest
magex update:installBuild Commands
View all build commands
magex helpCommon commands:
magex build— Build the binarymagex test— Run test suitemagex lint— Run all lintersmagex deps:update— Update dependencies
GitHub Workflows
ATLAS uses the Fortress workflow system for comprehensive CI/CD:
- fortress-test-suite.yml — Complete test suite across multiple Go versions
- fortress-code-quality.yml — Code quality checks (gofmt, golangci-lint, staticcheck)
- fortress-security-scans.yml — Security vulnerability scanning
- fortress-coverage.yml — Code coverage reporting to Codecov
- fortress-release.yml — Automated binary releases via GoReleaser
See all workflows in .github/workflows/.
Updating Dependencies
To update all dependencies (Go modules, linters, and related tools), run:
magex deps:updateThis command ensures all dependencies are brought up to date in a single step, including Go modules and any managed tools. It is the recommended way to keep your development environment and CI in sync with the latest versions.
Read more about this Go project's code standards.
Read the AI Usage & Assistant Guidelines for details on how AI is used in this project and how to interact with AI assistants.
| MrZ |
View the contributing guidelines and please follow the code of conduct.
All kinds of contributions are welcome 🙌! The most basic way to show your support is to star 🌟 the project, or to raise issues 💬. You can also support this project by becoming a sponsor on GitHub 👏 or by making a bitcoin donation to ensure this journey continues indefinitely! 🚀