tops-bmad

BMAD CLI Tool

A command-line tool to set up BMAD (Business Model and Architecture Design) workflow files in your project.

🚀 Installation

Global Installation (Recommended)

npm install -g tops-bmad

Using npx (No Installation Required)

npx tops-bmad

🔐 Encryption

The BMAD package zip file is encrypted for security. Before distributing the package, you need to encrypt it:

npm run encrypt-zip

This will:

• Prompt you for a secret key (password)
• Encrypt the bmad-package.zip file
• Create a backup of the original file as bmad-package.zip.backup

Important: Keep the secret key secure and share it only with authorized users who need to install the BMAD package.

Testing Decryption

To verify that the encrypted file can be decrypted correctly:

npm run test-decryption

This test script will:

• Prompt you for the secret key
• Decrypt the encrypted zip file
• Verify the zip file integrity
• Optionally extract and display the contents
• Clean up test files automatically

This is useful for verifying that encryption/decryption works correctly before distribution.

🛠️ Usage

• Navigate to your project directory

• Run the BMAD CLI:

  npx tops-bmad
  

• Enter the secret key when prompted (the password used to encrypt the package)

• Enter your project name when prompted

• The tool will:

  • Clean up any existing BMAD files
  • Decrypt and extract the BMAD package
  • Set up all necessary files and directories
  • Update project references

📁 Project Structure

After installation, your project will include:

.your-project/
├── .bmad/           # BMAD configuration and templates
└── .cursor/rules/   # Cursor IDE rules and workflow commands
    ├── bmad/        # BMAD-specific rules
    ├── ba-workflow-init-command.mdc
    ├── dev-workflow-init-command.mdc
    └── qa-workflow-init-command.mdc

🔄 Updating

To update to the latest version:

npm update -g tops-bmad

🤝 Contributing

Contributions are welcome! Please open an issue or submit a pull request.

📝 License

MIT