Command Reference

bgrun has 18 subcommands. All commands return JSON to stdout when piped, or human-readable output when connected to a terminal.

The daemon auto-starts on the first CLI invocation. You don’t need to manually start it.

run

Start a background process.

bgrun run [OPTIONS] <cmd> [args...]

Flags

Examples

# Simple background process
bgrun run "npm run dev"

# Named + readiness
bgrun run --name server --ready-when "listening on" "cargo run"

# With restart
bgrun run --name worker --restart on-crash --backoff 5s "python worker.py"

# Depends on another job
bgrun run --name tests --after server "cargo test"

# PTY allocation
bgrun run --pty "npm run dev"

Output (JSON)

{"id":"abc123","name":"server","workspace":null,"cmd":["cargo","run"],"pid":12345,"state":"running","started_at":"2026-05-31T00:00:00Z"}

If a named job is already running, the existing record is returned instead of spawning a duplicate.

run-group

Start multiple named jobs in parallel. Each name is resolved from bgrun.toml (see bgrun.toml Reference). Jobs respect their after dependencies — the group waits for each job’s dependencies before spawning it.

bgrun run-group <NAME> [NAME...]

Examples

# Start all jobs defined in bgrun.toml
bgrun run-group db server worker

# Start specific group
bgrun run-group server worker

Output (JSON)

[
  {"id":"aaa","name":"server","state":"running",...},
  {"id":"bbb","name":"worker","state":"running",...}
]

list

List all known jobs, or filter by workspace.

bgrun list [--workspace <WS>]

Examples

# All jobs
bgrun list

# Jobs in a specific workspace
bgrun list --workspace myapp

Output (JSON) — one JSON object per line (NDJSON):

{"id":"abc","name":"server","workspace":"myapp","cmd":["cargo","run"],"pid":12345,"state":"running","started_at":"..."}
{"id":"def","name":"worker","workspace":"myapp","cmd":["python","worker.py"],"pid":12346,"state":"exited","started_at":"..."}

status

Get the current state of a job.

bgrun status [<ID>] [--name <NAME>]

Flags

Examples

bgrun status abc123
bgrun status server  # works with names too
bgrun status --name server

Output (JSON)

{"state":"running","exit_code":null,"ready_at":null,"restart_count":0,"last_diff_cursor":0}

tail

Show the last N lines of a job’s stdout/stderr log.

bgrun tail <ID> [--lines <N>] [--digest] [--level <LEVEL>] [--stream <S>] [--strip-ansi] [--follow] [--filter-regex <R>]

Flags

Examples

# Last 10 lines
bgrun tail server --lines 10

# Digest summary
bgrun tail server --digest

# Show only lines containing "error"
bgrun tail server --level error

Output (JSON)

{
  "lines": [
    {"line_number": 42, "content": "listening on :8080", "timestamp": null},
    {"line_number": 43, "content": "GET / 200 OK", "timestamp": null}
  ]
}

Human output colorizes errors in red and warnings in yellow.

diff

Show log lines added since the last diff call (tracked via cursor).

bgrun diff <ID> [--lines <N>] [--stream <S>] [--strip-ansi] [--filter-regex <R>]

Flags

Examples

# First call: all log content
bgrun diff server

# Later: only new lines since last call
bgrun diff server

Output (JSON)

{
  "cursor": 2048,
  "lines": [
    {"line_number": 100, "content": "some new output", "timestamp": null}
  ]
}

wait

Block until a job reaches Ready state, or a timeout elapses. If the job exits or crashes before becoming ready, returns immediately with the terminal state and exit code.

bgrun wait <ID> [--timeout <DURATION>]

Examples

# Wait up to 60s
bgrun wait server

# Wait up to 5 minutes
bgrun wait db --timeout 5m

Output (JSON)

{"ready":true,"elapsed_ms":1234,"exit_code":null,"state":null}

If the job exits with code 0 before becoming Ready (pattern not matched):

{"ready":false,"elapsed_ms":350,"exit_code":0,"state":"exited"}

If the job crashes before becoming Ready:

{"ready":false,"elapsed_ms":150,"exit_code":1,"state":"crashed"}

If the timeout elapses while the job is still Running:

{"ready":false,"elapsed_ms":60000,"exit_code":null,"state":null}

kill

Terminate a job by ID, name, or entire workspace.

bgrun kill [<ID>] [--name <NAME>] [--workspace <WS>]

Flags

Sends SIGTERM first, then SIGKILL after 5 seconds if the process hasn’t exited. Sends to the entire process group, so child processes are cleaned up.

Examples

# Kill by ID
bgrun kill abc123

# Kill by name
bgrun kill server
bgrun kill --name server

# Kill all jobs in a workspace
bgrun kill --workspace myapp

Output (JSON) — single kill:

{"killed":["abc123"]}

Workspace kill:

{"killed":["abc123","def456"]}

send

Write data to a job’s stdin.

bgrun send <ID> [<DATA>] [--newline] [--enter]

Flags

Examples

# Send text
bgrun send server "/reload"

# Append newline
bgrun send server "/reload" --newline

# Send just Enter (press Return)
bgrun send server --enter

# Send text followed by Enter
bgrun send server "yes" --enter

# Using shell escape
bgrun send server $'yes\n'

Output (JSON)

{"ok":true}

Works with both piped and --pty jobs.

stats

Show CPU and memory usage of a running process.

bgrun stats <ID>

Examples

bgrun stats server

Output (JSON)

{"cpu_pct":2.4,"rss_mb":48,"uptime_secs":3600}

skill

Install the embedded skill bundle to a target directory.

bgrun skill install <DIR>

Examples

bgrun skill install ~/.config/opencode/skills/bgrun

Output

Installed skill to /home/user/.config/opencode/skills/bgrun/SKILL.md

attach

Attach to a PTY job’s interactive terminal. Enables raw bidirectional communication with a process running in a pseudo-terminal.

bgrun attach <ID>

Examples

bgrun attach server

Once attached, the terminal enters raw mode:

• Keystrokes are forwarded to the PTY job’s stdin.
• The job’s PTY output is displayed live.
• Ctrl+C detaches without killing the job (unlike a normal terminal).
• *Ctrl+* (SIGQUIT) is also forwarded but may terminate the job.
• Terminal resize events are forwarded to the PTY master.

The connection is closed automatically when the job exits.

screen

Show last N lines from a job’s in-memory ring buffer (non-blocking). Unlike bgrun tail, this reads from a live memory buffer rather than disk, making it suitable for rapid polling without I/O overhead.

bgrun screen <ID> [--lines <N>]

Flags

Examples

# Last 20 lines
bgrun screen server

# Last 5 lines
bgrun screen server --lines 5

Output (JSON)

["line 1", "line 2", "line 3"]

Human output prints each line directly.

clean

Remove all terminated (crashed/exited/killed) jobs.

bgrun clean [--workspace <WS>] [--force]

Flags

Examples

# Remove all terminated jobs
bgrun clean

# Remove only terminated jobs in a workspace
bgrun clean --workspace myapp

# Skip confirmation
bgrun clean --force

Output (JSON)

{"removed":["abc123","def456"]}

expect

Wait for a pattern to appear in a job’s log output. Returns when the pattern is found or the timeout expires.

bgrun expect <ID> <PATTERN> [--regex] [--timeout <DURATION>]

Flags

Examples

# Wait for substring
bgrun expect server "listening on"

# Wait for regex
bgrun expect server "http://localhost:\d+" --regex

# With custom timeout
bgrun expect server "ready" --timeout 10s

Output (JSON) — on match:

{"matched":true,"line_number":42,"content":"listening on :8080"}

On timeout:

{"matched":false,"line_number":null,"content":null}

schema

Print JSON Schema (draft-07) for a command’s argument struct. Designed for AI agents to discover the expected input shape at runtime.

bgrun schema <COMMAND>

Supported commands: run, kill, tail.

Examples

bgrun schema run
bgrun schema kill
bgrun schema tail

Output (JSON) — a standard JSON Schema document with title, type, properties, and required fields.

completions (hidden)

Hidden subcommand for shell autocomplete scripts. Prints tab-separated job information for shell tab-completion, or generates full completion scripts.

bgrun completions --active-ids
bgrun completions --workspaces
bgrun completions --shell fish
bgrun completions --shell bash
bgrun completions --shell zsh

Flags

Installation

# Fish
bgrun completions --shell fish > ~/.config/fish/completions/bgrun.fish

# Bash
bgrun completions --shell bash | sudo tee /etc/bash_completion.d/bgrun

# Zsh
bgrun completions --shell zsh > /usr/local/share/zsh/site-functions/_bgrun

Dynamic completion integration

The --active-ids and --workspaces flags produce live data from the daemon, used by shell functions:

# In ~/.config/fish/completions/bgrun.fish:
complete -c bgrun -n "__fish_seen_subcommand_from status kill wait tail diff send stats attach expect" -a "(bgrun completions --active-ids)"
complete -c bgrun -n "__fish_seen_subcommand_from list kill; and __fish_prev_arg_in --workspace" -a "(bgrun completions --workspaces)"

Interactive menu

Running bgrun without any subcommand opens an interactive TUI menu:

• List & Refresh Jobs — runs bgrun list
• View Job Status/Stats — select a job, shows status and resource stats
• Attach to Interactive PTY — select a job and attach
• Tail Job Logs — select a job, shows last 20 lines
• Kill a Job — select a job and kill it
• Exit Menu

The job list is populated live from the daemon, showing short ID, name, state, and command.

ID resolution

All commands that accept a job ID also accept:

• Full UUID — the canonical job identifier
• Job name — as set with --name
• Unique prefix — at least 4 characters of the UUID that match exactly one job

bgrun status abc1          # prefix match
bgrun status my-server     # name match
bgrun status abc12345...   # full UUID

Job States

Jobs transition through these states:

Starting ──► Running ──► Ready
   │            │
   ▼            ▼
 Exited       Crashed    (non-zero exit / SIGKILL)
                  Killed  (explicit kill)

A job in any of Starting, Running, or Ready is considered “alive.” Exited, Crashed, and Killed are terminal states.