beads Development Container
This devcontainer configuration provides a fully-configured development environment for beads with:
- Go 1.23 development environment
- bd CLI built and installed from source
- Git hooks automatically installed
- All dependencies pre-installed
Quick Start
GitHub Codespaces
- Click the "Code" button on GitHub
- Select "Create codespace on main"
- Wait for the container to build (~2-3 minutes)
- The environment will be ready with bd installed and configured
VS Code Remote Containers
- Install the Remote - Containers extension
- Open the beads repository in VS Code
- Click "Reopen in Container" when prompted (or use Command Palette: "Remote-Containers: Reopen in Container")
- Wait for the container to build
What Gets Installed
The setup.sh script automatically:
- Builds bd from source (
go build ./cmd/bd) - Installs bd to
/usr/local/bin/bd - Runs
bd init --quiet(non-interactive initialization) - Installs git hooks from
examples/git-hooks/ - Downloads Go module dependencies
Verification
After the container starts, verify everything works:
# Check bd is installed
bd --version
# Check for ready tasks
bd ready
# View project stats
bd stats
Git Configuration
Your local .gitconfig is mounted into the container so your git identity is preserved. If you need to configure git:
git config --global user.name "Your Name"
git config --global user.email "your.email@example.com"
Troubleshooting
bd command not found:
- The setup script should install bd automatically
- Manually run:
bash .devcontainer/setup.sh
Git hooks not working:
- Check if hooks are installed:
ls -la .git/hooks/ - Manually install:
bash examples/git-hooks/install.sh
Container fails to build:
- Check the container logs for specific errors
- Ensure Docker/Podman is running and has sufficient resources
- Try rebuilding: Command Palette → "Remote-Containers: Rebuild Container"
Related Issues
- GitHub Issue #229: Git hooks not available in devcontainers
- bd-ry1u: Publish official devcontainer configuration