Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

bgrun

CI License: MIT

Run long-running background tasks easily. Perfect for development servers, test suites, and AI agent automation loops.

bgrun manages your background tasks so you can keep working without terminal lockups. Start servers, track their readiness, tail logs, and shut them down; all over an automatic background daemon using structured JSON payloads.

Install

# Quick install (Linux)
curl -fsSL https://bethropolis.github.io/bgrun/install.sh | sh

# AUR (Arch Linux)
yay -S bgrun-bin

# Homebrew (Linux)
brew tap bethropolis/tap && brew install --cask bethropolis/tap/bgrun

# From source
./install.sh   # requires Rust toolchain

Quick start

1. Run a Process

Launch a process in the background and tell bgrun exactly when it is ready to handle traffic:

bgrun run --name dev-server --ready-when-port 3000 "npm run dev"

2. Coordinate Your Workflow

Block execution only until the server is actually ready, inspect its logs, or terminate it cleanly:

# Block until ready (not a must!)
bgrun wait dev-server --timeout 30s

# Check on-demand logs
bgrun tail dev-server --lines 10

# Clean up
bgrun kill dev-server

Commands

CommandPurpose
bgrun run [flags] <cmd...>Start a background job
bgrun list [--workspace <ws>]List all jobs
bgrun status <id>Get job state
bgrun wait <id> --timeout <d>Block until ready
bgrun tail <id> [--digest] [--level <l>]Show logs
bgrun diff <id>New log lines since last call
bgrun send <id> <data>Write to stdin
bgrun stats <id>Show CPU/RSS/uptime
bgrun kill <id> [--workspace <ws>]Terminate job(s)
bgrun attach <id>Attach to PTY job interactively
bgrun expect <id> <pattern>Wait for log line matching pattern
bgrun schema <command>Print JSON Schema for command args
bgrun run-group <name> [name...]Start multiple named jobs in parallel
bgrun screen <id> [--lines N]Show last N lines from in-memory ring buffer
bgrun clean [--workspace <ws>]Remove all terminated jobs
bgrun skill install <dir>Install embedded skill bundle

Docs

Crate layout

CrateRole
bgrun-protoShared types, no I/O
bgrun-coreJob state machine, config parser
bgrun-daemonSpawns/monitors/kills processes, serves CLI
bgrun-cliUser-facing CLI

License

MIT