borris-flow
v1.0.2
Published
Borris-style Claude workflow bootstrap and parallel worktree orchestration utilities.
Maintainers
Readme
Why teams use Borris-Flow
- ⚡ Fast onboarding — one command to add a consistent local Claude workflow to any repo.
- 🧭 Parallel execution — scale feature delivery through isolated worktrees.
- 🔒 Safe by default — explicit
--force, clear prompts, and--dry-runfor risk-free planning. - 🧰 Consistent conventions — reusable
.claude/andCLAUDE.mdstructure across projects. - 🤝 Reliable handoffs — task prompts in
TASK.mdand machine-readable output for tooling.
Quickstart
1) Install the toolchain
# Option A: npm (recommended for users)
npm install -g borris-flow
# Option B: local install from source
# Clone and enter the repo
# https://github.com/itisrmk/Borris-Flow.git
git clone https://github.com/itisrmk/Borris-Flow.git
cd Borris-Flow
# Install global entrypoints
make install
# Add ~/.local/bin to PATH (if needed)
export PATH="$HOME/.local/bin:$PATH"2) Scaffold a project
# Scaffold in the current repo
borris-flow init
# Scaffold a target repo
borris-flow init /path/to/your-project
# Overwrite when needed
borris-flow init /path/to/your-project --force
borris-flow --force init /path/to/your-project3) Run your first workflow
# Run parallel tasks from project root
borris-workflow "auth: add SSO login" "ui: improve status banner" "tests: stabilize flakies"
# Or from anywhere
borris-workflow --project-root /path/to/your-project "analytics: reduce p95 latency"Tip: run with
--dry-runfirst to preview everything before creating branches and worktrees.
Usage
1) Project bootstrap (borris-flow)
borris-flow creates the workflow scaffold:
borris-flow init
borris-flow init /path/to/repo
borris-flow init /path/to/repo --force
borris-flow --force init /path/to/repoSupported options:
--help(-h) — show usage--version(-V) — show version--force(-f) — overwrite scaffold files
2) Parallel workflow automation (borris-workflow)
Create isolated branches/worktrees for each task:
borris-workflow "feature: stabilize flaky tests" "feature: improve CLI output"
borris-workflow --project-root /path/to/repo --json "feature: add webhook support"
borris-workflow --dry-run "feature: preview without changes"Supported flags:
--project-root <path>— target repo--base <ref>— base branch/ref (default: current branch)--max <N>— max number of auto-launched terminals--launch/--no-launch— control Claude terminal startup--dry-run— show plans only--json— machine-readable output--help
Expected JSON sections:
plannedcreatedresults
3) Maintenance
make install # one-shot install entrypoints
make install-force # overwrite symlinks if needed
make verify # script syntax checks + JSON smoke test
make lint # alias for verify
make clean # remove managed ~/.local/bin linksNeed concrete recipes? See EXAMPLES.md.
Repository contents
borris-flow— bootstrap CLI to install workflow conventions.borris-workflow— orchestrates parallel feature worktrees.scripts/borris-workflow.sh— core workflow engine.scripts/install-borris-workflow.sh— one-step installer.Makefile—install,verify,lint,clean..claude/commands/*,.claude/agents/*— reusable coding workflows and roles.- Docs & process —
EXAMPLES.md,CONTRIBUTING.md,RELEASE.md,ABOUT.md.
Optional: power-up with Ruflo
Ruflo is optional and intentionally non-blocking.
ruflo task create ...ruflo task listruflo task status <id>
Core workflow remains Claude-first.
License
This project is released under the MIT License.
