runbook

Remember project commands. Run them from anywhere.

The Problem

Every project runs differently. You can't remember. You check the README every time.

# Is it...
npm run dev
# or
npm start  
# or
pnpm dev
# or  
python manage.py runserver
# or
go run main.go

Stop guessing. Stop checking.

The Solution

Set it once. Run it forever.

# Set commands
runbook set dev "npm run dev"
runbook set test "npm test"
runbook set build "npm run build"

# Run from anywhere in the project
runbook dev

# That's it.

Install

npm install -g runbook-cli

Usage

Set Commands

# Basic
runbook set dev "npm run dev"

# With install
runbook set dev "npm install && npm run dev"

# Backend
runbook set start "python manage.py runserver"

# Docker
runbook set up "docker-compose up -d"

# Multi-step
runbook set deploy "npm run build && npm run test && git push"

Run Commands

# Run a command
runbook dev

# Works from any subfolder
cd src/components
runbook dev  # Still works!

# Short alias
rb dev

List Commands

# See all commands
runbook list

# Or just
runbook

Delete Commands

runbook delete dev
# or
runbook rm dev

Project Info

runbook info

How It Works

• Finds your git root automatically
• Stores commands in .runbook in project root
• Works from any subfolder
• Team shares via git (commit .runbook)

Example Workflow

# New project
cd my-project
runbook set dev "npm install && npm run dev"
runbook set test "npm test"

# 3 months later, can't remember
runbook
# Shows: dev, test

runbook dev
# Runs instantly

# In subfolder
cd src/pages
runbook dev
# Still works!

Team Usage

Commit .runbook to git:

git add .runbook
git commit -m "Add runbook commands"

Now everyone runs:

runbook dev  # Works for everyone

Commands Reference

runbook set <name> <command>   # Set a command
runbook <name>                 # Run a command
runbook list                   # List all commands
runbook delete <name>          # Delete a command
runbook info                   # Show project info
runbook                        # Show available commands
rb                             # Short alias

Examples

Node.js

runbook set dev "npm install && npm run dev"
runbook set build "npm run build"
runbook set test "npm test"

Python/Django

runbook set dev "pip install -r requirements.txt && python manage.py runserver"
runbook set migrate "python manage.py migrate"
runbook set shell "python manage.py shell"

Go

runbook set dev "go run main.go"
runbook set build "go build -o bin/app"
runbook set test "go test ./..."

Docker

runbook set up "docker-compose up -d"
runbook set down "docker-compose down"
runbook set logs "docker-compose logs -f"

Full Stack

runbook set dev "docker-compose up -d && npm run dev"
runbook set backend "cd backend && python manage.py runserver"
runbook set frontend "cd frontend && npm start"

Why runbook?

• No more README diving - Commands right there
• Works everywhere - Any subfolder, always works
• Team onboarding - New dev runs runbook dev, done
• Cross-language - Node, Python, Go, Rust - doesn't matter
• Zero config - Just set and run

Data Storage

Commands stored in .runbook in project root (JSON format).

{
  "dev": "npm run dev",
  "test": "npm test",
  "build": "npm run build"
}

License

MIT

Author

Built by Brian Mwirigi

Stop thinking. Start running.