Configuration Reference
Bloom uses two configuration files: workspace config and user config.
Workspace Configuration
bloom.config.yaml
Located in the workspace root. Created by bloom init.
repos:
- url: [email protected]:myorg/backend.git
name: backend
- url: [email protected]:myorg/frontend.git
name: frontend
- url: https://github.com/myorg/shared.git
name: shared
Properties
repos
List of repositories in the workspace.
repos:
- url: <git-url>
name: <local-name>
| Property | Type | Description |
|---|---|---|
url | string | Git clone URL (SSH or HTTPS) |
name | string | Local directory name |
Management
Repositories are automatically added when you run bloom repo clone:
bloom repo clone myorg/backend
# Adds entry to bloom.config.yaml
Manual editing is also supported:
repos:
- url: [email protected]:myorg/new-repo.git
name: new-repo
Then sync:
bloom repo sync
User Configuration
~/.bloom/config.yaml
Global user settings. Created on first use.
git_protocol: ssh
Properties
git_protocol
Preferred protocol for repository URLs.
git_protocol: ssh # [email protected]:org/repo.git
git_protocol: https # https://github.com/org/repo.git
- Type:
enum - Values:
ssh,https - Default: Prompted during
bloom init
Management
View current config:
bloom config
Change protocol:
bloom config set-protocol ssh
bloom config set-protocol https
Project Files
PRD.md
Product Requirements Document. Template from template/PRD.md.
Recommended sections:
- Overview
- Problem Statement
- Requirements (Functional, Non-Functional)
- Technical Constraints
- Success Criteria
- Out of Scope
plan.md
Implementation plan. Generated by bloom plan.
Contains:
- Phases
- Steps within phases
- Dependencies
- Technical details
CLAUDE.md
Guidelines for AI agents. Template from template/CLAUDE.template.md.
Recommended sections:
- Code Standards
- Architecture Overview
- Testing Requirements
- Git Practices
tasks.yaml
Task definitions. Generated by bloom generate.
See Task Schema for full reference.
Template Files
Located in template/ directory.
template/PRD.md
Template for new project PRDs.
# [Project Name]
## Overview
[Description]
## Requirements
- [ ] Requirement 1
## Success Criteria
- [ ] Criterion 1
template/plan.md
Template for implementation plans.
# Implementation Plan
## Phase 1: [Name]
### 1.1 [Step]
- Detail 1
- Detail 2
template/CLAUDE.template.md
Template for agent guidelines. Becomes CLAUDE.md in projects.
# Project Guidelines
## Code Style
[Standards]
## Testing
[Requirements]
Directory Structure
Workspace
my-workspace/
├── .gitignore # Excludes repos/
├── bloom.config.yaml # Workspace config
├── repos/ # Repositories
│ ├── backend.git/ # Bare repo
│ ├── backend/ # Default worktree
│ └── backend-feature-x/ # Feature worktree
├── template/ # Project templates
│ ├── PRD.md
│ ├── plan.md
│ └── CLAUDE.template.md
└── my-project/ # Project directory
├── PRD.md
├── plan.md
├── CLAUDE.md
└── tasks.yaml
User Config
~/.bloom/
└── config.yaml # User settings
Defaults
| Setting | Default |
|---|---|
| Git protocol | Prompted on init |
| Task status | todo |
| Agent | claude-code |
| Worktree | Repository default branch |
Validation
Workspace Config
Must have valid YAML syntax. Repos must have url and name.
Task File
Run validation:
bloom validate
Checks:
- YAML syntax
- Required fields
- Unique IDs
- Valid dependencies
- No circular references