🌿 BIMMO CLI – Nature Green & Lavender Visual Identity

BIMMO is your intelligent Spec-Driven Development (SDD) assistant. It transforms abstract concepts into rigorous, structured, and ready-to-execute technical documentation. With a modern interface inspired by nature (Green and Lavender), BIMMO guides you from the birth of an idea to the detailed planning of an AI agent Swarm.

🎨 Visual Identity

BIMMO uses a balanced color palette:

• Nature Green: Represents growth and the birth of new projects.
• Lavender (Blueish Purple): Brings mental clarity and technical sophistication to specifications.

🛠️ Installation and Setup

To install BIMMO globally on your machine, use the command:

npm install -g bimmo-cli

Now you can simply type bimmo in any terminal.

🚀 How to Use (Workflow)

BIMMO operates through a rich interactive terminal. Just type bimmo to enter the dashboard.

1. Creating your First Project

Inside the BIMMO CLI, use:

/new my-amazing-project

This initializes the project state and creates the matrix structure in the hidden .bimmo directory.

2. Configuring your AI Profile

BIMMO supports various providers (OpenRouter, OpenAI, Anthropic, Google, local via Ollama, etc.).

/profile new

Follow the wizard to set up profile name, provider, API key, and preferred model.

3. Generating SDD Documentation (All-in-One)

With a project open and profile configured, describe your idea:

/all "An NFT marketplace focused on generative art with auction support"

BIMMO will sequentially generate:

• Constitution: Mission and values.
• Spec: Technical specification.
• Plan: Implementation plan.
• Tasks: Task list.
• Data Model: Textual data modeling.
• ER & Class Diagrams: Mermaid visual diagrams (.mmd).
• Research: Necessary technical research.
• Quickstart: Quick start guide.

🦾 Advanced Features

👥 Agent Management (/agents)

Create specialized agents for specific tasks.

• /agents new: Opens the wizard to define ID, Role, and System Prompt.
• /agents list: Lists your custom agents.

🐝 Agent Swarms (/swarm)

Configure agent orchestrations to work together on your project.

• /swarm new: Defines a new Swarm and maps tasks to specific agents.
• /swarm list: Lists swarms for the current project.
• /swarm use <name>: Activates a specific swarm.
• /swarm start: Starts the execution of the active swarm.
• /swarm dry-run: Simulates the swarm execution without making real AI calls or disk changes.

🧠 Memory & Global Preferences (/memory)

BIMMO remembers your coding style and favorite technologies across projects.

• /memory: Opens a wizard to set your favorite tech stack, coding style (e.g., Clean Architecture), and global instructions (e.g., "always use TypeScript strict mode"). These preferences are injected into every agent's system prompt.

🐙 Git & GitHub Integration

BIMMO is now git-aware and handles your workflow automatically during Swarms:

• Auto-Branching: Automatically creates a new branch for each Swarm execution (e.g., bimmo-swarm-project-1234).
• Task Commits: Performs a git commit after each successful task completion.
• Draft PRs: If you have the GitHub CLI (gh) installed, BIMMO will automatically create a Draft Pull Request with a summary of the work done after the Swarm finishes.
• Rollback: Use /rollback to undo changes if something goes wrong (uses git stash pop).

📝 Automated Documentation (/docs)

Keep your project documentation in sync with your progress.

• /docs: Invokes the Documentation Agent to update your README.md and CHANGELOG.md based on the latest Swarm results and project state.

🚀 Developer Experience (DX)

• UI Preview: Use /preview to launch your development server (runs npm run dev) in the background directly from the BIMMO terminal.
• Structured Logs: Use /logs to export your current session logs to a structured .json file for auditing or debugging.
• BIMMO Doctor: Use /doctor to run a diagnostic of your environment (Node version, Git setup, API connectivity).

🔍 Smart Input & Autocomplete

• Multi-line Input: Advanced text area with full arrow navigation (Up/Down/Left/Right).
• Syntax Highlighting: Files and directories marked with @ are automatically highlighted in Cyan.
• Interactive Menus: Navigate through choices (Approvals, Resume, Questions) using arrow keys.
• Auto-accept: Option to "Always allow" tool execution during a session for maximum speed.
• Slash Commands: Type / to see available commands.

📡 Streaming and Real-time Activity

BIMMO offers a live experience:

• Real-time Activity: See the AI "write" matrices and code character by character.
• Focus Panel: The interface adapts automatically to show the thinking process of the active agent.

📊 Mermaid Integration

Data models are no longer just text. BIMMO generates:

• data-model-er.mmd: Visual Entity-Relationship diagrams.
• data-model-class.mmd: Technical Class diagrams. Compatible with VS Code Mermaid extensions and GitHub native rendering.

🌐 WebSearch & Extraction

Agents can search the internet and read official documentation via Tavily integration.

• /config set-tavily <your_key>: Configures the Tavily API for searches.

🧠 Context Management (Summarization)

To prevent AI from "forgetting" the project goal during long Swarm sessions, BIMMO automatically compresses previous task history when it exceeds a character limit.

• /config set-context <number>: Sets the character threshold before summarization (Default: 15,000). Tip: Increase this value (e.g., 50,000+) if you are using models with massive context windows like Gemini 2.0 or Claude 3.5.

📂 Generated Matrices (.bimmo/)

| Document | Purpose | | :--- | :--- | | constitution.md | The "why" of the project and ethical rules. | | spec.md | The "what" - functional and non-functional requirements. | | plan.md | The "how" - architecture and development phases. | | tasks.md | List of concrete actions for developers. | | data-model.md | Textual data schemas and information flows. | | data-model-er.mmd | Mermaid ER Diagram for database structure. | | data-model-class.mmd | Mermaid Class Diagram for code implementation. | | research.md | Exploration of technologies and libraries. | | quickstart.md | Instructions to run the MVP in minutes. |

⌨️ Command Reference

• /new <name>: Initializes a new project.
• /all <description>: Generates the full SDD via AI.
• /profile [new|list]: Manages API profiles.
• /agents [new|list]: Manages custom agents.
• /swarm [new|list|use|start]: Agent orchestration.
• /config set-tavily <key>: Configures the Tavily API for searches.
• /config set-context <limit>: Configures the summarization threshold.
• /config set-profile <name>: Manually switches the active AI profile.
• /help: Shows help.
• /exit: Exits BIMMO.

⌨️ Shortcuts

• F12: Toggle Debug Mode (shows technical logs and API errors).
• Esc: Interrupt current process.
• Double Ctrl+C: Fast exit.
• Tab / Arrows: Navigate autocomplete suggestions and menus.

📄 License

This project is distributed under the MIT License. MO.

⌨️ Shortcuts

• F12: Toggle Debug Mode (shows technical logs and API errors).
• Esc: Interrupt current process.
• Double Ctrl+C: Fast exit.

📄 License

This project is distributed under the MIT License.