Getting Started

Add DevMagic to your project in seconds, or explore other ways to use it.

Prerequisites

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 push

Step 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

DevMagic - Your Development Environment, Anywhere