audited-runbook 0.1.0

Run multi-step shell procedures with atomic audit trail. Every step persisted before execution. Every failure recorded. No silent drops.

Audited Runbook Executor

Multi-step shell procedures with atomic audit trail. Every step is persisted before execution. Every failure is recorded. No silent drops.

Install

pip install audited-runbook

From source:

pip install -e .

Verify

runbook --help

Run a runbook

runbook run runbooks/test-success.yaml

With overrides:

runbook run --cwd /tmp --env FOO=bar --env BAZ=qux runbooks/test-success.yaml
runbook run --db /tmp/my.db runbooks/test-success.yaml

Query history

runbook history
runbook history -n 5

Inspect an execution

runbook inspect <execution-id>

View audit trail

runbook audit <execution-id> --pretty
runbook audit <execution-id>            # raw JSON

Validate a runbook (no execution)

runbook validate runbooks/test-success.yaml

Runbook format

name: my-deploy
description: Optional description.
steps:
  - name: run-tests
    command: pytest tests/ -x
  - name: build
    command: docker build -t myapp .
    timeout_seconds: 300

Default database

~/.runbook/runbook.db — override with --db PATH.