tops-bmad/README.md

CLI tool to install BMAD workflow files into any project with integrated Shai-Hulud 2.0 security scanning

# 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)

```bash
npm install -g tops-bmad
```

### Using npx (No Installation Required)

```bash
npx tops-bmad
```

## 🔐 Encryption

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

```bash
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:

```bash
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

1. Navigate to your project directory
2. Run the BMAD CLI:

   ```bash
   npx tops-bmad
   ```

3. Enter the secret key when prompted (the password used to encrypt the package)
4. Enter your project name when prompted
5. 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:

```text
.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:

```bash
npm update -g tops-bmad
```

## 🤝 Contributing

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

## 📝 License

MIT