Getting Started
Add DevMagic to your project in seconds, or explore other ways to use it.
Prerequisites
- Container Runtime: Install Podman Desktop or Docker
- Editor: Install Visual Studio Code (or any Dev Container compatible editor)
Add DevMagic to Your Project
One command to provide instant, consistent development environments for all contributors.
Step 1: Run the Installer
From your project root, run the DevMagic installer:
curl -fsSL https://devmagic.run/install | bash💡 Always review scripts before running: curl -fsSL https://devmagic.run/install
Step 2: Project Structure
The installer creates a .devcontainer/ directory with:
your-project/
├── .devcontainer/
│ ├── devcontainer.json
│ └── docker-compose.yml
├── src/
└── ...Step 3: Commit to Your Repository
Add the dev container configuration to version control:
git add .devcontainer/
git commit -m "feat: add DevMagic development environment"
git pushStep 4: Contributors Get Started Instantly
When contributors clone your project and open it in VS Code, they just select "Reopen in Container" when prompted. Everyone gets the same environment with:
- ✓Node.js, pnpm, Git, GitHub CLI
- ✓Docker-in-Docker for containerized apps
- ✓Zsh with Oh My Zsh
- ✓AI CLI tools (aider, GitHub Copilot CLI, etc.)
Customization
Customize .devcontainer/devcontainer.json for your project's needs:
- • Add project-specific VS Code extensions
- • Configure environment variables
- • Enable auxiliary services (PostgreSQL, Redis, etc.)
- • Adjust the base image or features
Next Steps
- Read the documentation →
Learn about auxiliary services, customization, and how it all works
- Explore features →
See what makes DevMagic powerful and flexible
- Get help or contribute →
Join the community, report issues, or contribute improvements