Skip to content

About

The rigid, minimalist, and operational framework for local software development.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

94 Commits

Folders and files

Repository files navigation

Baremetal-Crew (BMC)

A rigid, minimalist, and highly structured human/agent development framework for local, monolithic software projects.


📖 What is Baremetal-Crew?

Baremetal-Crew enforces a linear, watertight workflow between a Human (CBO, Chief Baremetal Officer) and a Crew of specialized AI agents:

  1. Product Owner (PO): Interrogates the CBO to freeze functional scope (SXX-SCOPE.md).
  2. Software Architect (SA): Breaks down the scope into technical designs and atomic tasks (SXX-BLUEPRINT.md).
  3. Fullstack Dev: Implements code and unit tests blindly task-by-task.
  4. QA Engineer: Automates integration/E2E tests to verify implementation.
  5. Tech Guru: Evaluates technical needs and indexes/recommends external skills catalog.

For detailed information on the philosophy, roles, and the 4 inviolable phases, read the Baremetal-Crew Manifesto.

🔄 Slice Execution Lifecycle

Every development cycle operates as an isolated slice (SXX, e.g., S01, S02) that progresses sequentially through 4 phases:

sequenceDiagram
    autonumber
    actor CBO as 👤 CBO (Human)
    participant PO as 🎯 Product Owner
    participant TG as 🧙 Tech Guru
    participant SA as 📐 Software Architect
    participant Dev as 💻 Fullstack Dev
    participant QA as 🧪 QA Engineer

    Note over CBO,PO: Phase 1: The Grill
    CBO->>PO: 1. Feature Idea & Edge Cases
    PO->>CBO: 2. SXX-SCOPE.md
    CBO->>PO: 3. Sign-off (bmc-log cbo-sign SXX)

    Note over PO,SA: Phase 2: The Breakdown
    PO->>SA: 4. Signed Scope Hand-off
    opt Skills Advisory
        SA->>TG: Consult Catalog
        TG-->>SA: SXX-SKILLS-RECOMMENDED.md
    end
    SA->>CBO: 5. SXX-BLUEPRINT.md
    CBO->>SA: 6. Approval Gate (bmc-log cbo-sign SXX)

    Note over SA,QA: Phase 3: Blind Execution
    SA->>Dev: 7. Orchestrate Atomic Task
    loop Ping-Pong (max 3 attempts)
        Dev->>QA: Ready for QA (Code + Unit Tests)
        alt Tests Pass
            QA-->>Dev: QA Passed
        else Tests Fail
            QA-->>Dev: Pending Correction (Bug Report)
        end
    end
    QA->>SA: 8. All Tasks QA Passed

    Note over CBO,SA: Phase 4: Validation
    SA->>SA: Update Living Docs (ARCHITECTURE.md, DESIGN.md)
    SA->>CBO: 9. SXX-DEMO.md
    alt CBO Green Light
        CBO->>SA: Validated & Completed (Archived)
    else CBO Rejection
        CBO->>SA: Bug Fixes Needed (Revert to Phase 3)
    end
Loading
│ I. Phase 1: The Grill (Product Owner & CBO)
│   ├─ Interrogate CBO on requirements, constraints, and edge cases
│   ├─ Draft functional scope (.bmc-stuff/work/SXX-SCOPE.md)
│   └─ Await CBO review and sign-off on SXX-SCOPE.md
│ II. Phase 2: The Breakdown (Software Architect)
│   ├─ Draft technical blueprint (.bmc-stuff/work/SXX-BLUEPRINT.md) and atomic tasks
│   ├─ (Optional) Run Tech Guru audit & recommend skills (.bmc-stuff/work/SXX-SKILLS-RECOMMENDED.md)
│   └─ Await CBO review and sign-off on SXX-BLUEPRINT.md
│ III. Phase 3: Blind Execution (Dev & QA Subagents)
│   ├─ Implement tasks and unit tests blindly (Fullstack Dev)
│   ├─ Automate integration/E2E tests and enforce ping-pong limit (QA Engineer)
│   └─ Verify all tasks reach "QA Passed"
│ IV. Phase 4: Validation (Software Architect & CBO)
│   ├─ Update root living documentation (ARCHITECTURE.md, DESIGN.md, README.md)
│   ├─ Generate manual verification guide (.bmc-stuff/work/SXX-DEMO.md)
│   └─ Await CBO validation sign-off (Green Light -> Completed / Abort)

🚀 Installation & Setup

You can install Baremetal-Crew in a target project directory using either of the following options:

Option 1: Local Clone Installation

Use this option if you have already cloned the baremetal-crew repository locally. Run the installer script and pass the target project directory:

./install.sh /path/to/target/project -y -i

Installer Flags & Options

The install.sh script supports the following command-line flags:

Flag Short Description
-i, --index-skills -i Automatically clone, index pre-approved technical skills libraries, and update matching skills in .agents/skills/ during install.
-y, --yes -y Non-interactive mode (automatically confirms installation prompts).
-h, --help -h Display the installer help message and options.

Option 2: One-Command Remote Installation (Standalone)

Use this option to install the framework directly from GitHub without cloning the repo. The installer will automatically download and unpack the latest release package.

Navigate to your target project folder and run:

curl -L "https://raw.githubusercontent.com/devmunoz/baremetal-crew/master/install.sh" | bash

Note: To specify the target directory explicitly, pass it as a parameter using the bash -s syntax:

curl -L "https://raw.githubusercontent.com/devmunoz/baremetal-crew/master/install.sh" | bash -s -- /path/to/target/project


🛠️ Helper Utilities & Skills Management

Baremetal-Crew provides centralized CLI utilities under .bmc-stuff/bin/:

  • .bmc-stuff/bin/bmc-log: Manages execution state, phase transitions, task logs, and command error audits in .bmc-stuff/crew.db.
  • .bmc-stuff/bin/bmc-index-skills: Clones and indexes pre-approved skills repositories into .bmc-stuff/skills-cache/ and synchronizes matching skills under .agents/skills/.

Skills Indexer & Updater CLI Options (bmc-index-skills)

Flag / Option Description
-t, --target <path> Specify target project directory path (defaults to working directory).
-c, --check Check local .agents/skills/ for available updates without overwriting files.
-u, --update-local Automatically update local .agents/skills/ from primary crew skills and cache (default: enabled).
--no-update-local Skip updating local .agents/skills/.
-s, --silent Run silently without verbose terminal logs.

Example usage:

# Index skills catalog and update matching .agents/skills in target project
.bmc-stuff/bin/bmc-index-skills --target /path/to/project

# Check for local skill updates without overwriting
.bmc-stuff/bin/bmc-index-skills --check

🌟 Credits & Skill Sources

The primary crew skills and advisory skills indexing catalogs are inspired by and sourced from the following repositories:

About

The rigid, minimalist, and operational framework for local software development.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages