Skip to content

DeerHide/BMAD

Repository files navigation

BMAD

Personalized BMAD Installation and Configuration from Deerhide

Installation

Run the installation script to set up BMAD:

./scripts/install.sh

Or with force flag to overwrite existing links:

./scripts/install.sh force

What install.sh Does

The install.sh script automates the setup of BMAD by creating symbolic links (or bind mounts on WSL2) from your home directory to the BMAD installation directory. It sets up:

  • Cursor Commands: Links ~/.cursor/commands/bmad to the project's .cursor/commands/bmad directory
  • Claude Commands: Links ~/.claude/commands/bmad to the project's .claude/commands/bmad directory
  • Agent Workflows: Links ~/.agent/workflows/bmad to the project's .agent/workflows/bmad directory
  • BMAD Home Directory: Links ~/_bmad to the project's _bmad directory

The script automatically detects your operating system and uses appropriate linking methods:

  • On macOS and Linux: Creates symbolic links
  • On WSL2: Uses bind mounts for better compatibility with Windows file systems

WSL and Cursor Integration

Important for WSL2 users: Due to limitations with symlinks in WSL2, Cursor commands require manual linking within your project directory. After running install.sh, you'll see instructions to manually link the Cursor commands:

mkdir -p ./.cursor/commands
ln -s $BMAD_INSTALLATION_DIRECTORY/.cursor/commands/bmad ./.cursor/commands/bmad

The script will display the exact command with the correct path when running in WSL2. This ensures Cursor can properly access the BMAD commands within your project workspace.

_bmad Integration

The _bmad directory contains the core BMAD configuration, modules, and resources. The installation script links ~/_bmad to the project's _bmad directory for global access.

For project-specific usage: You may also want to link _bmad directly in your project directory:

ln -s $BMAD_INSTALLATION_DIRECTORY/_bmad ./_bmad

Git Configuration: Add the following to your .gitignore file to avoid committing these links:

_bmad
.cursor/commands/bmad

This keeps your repository clean while maintaining the BMAD integration in your local workspace.

About

Personalized BMAD Installation and Configuration from Deerhide

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages