Rookrunner

Quick start / v0.1.10

Start a local run.

The CLI uses a private state directory to find the worker socket and store run records. Put the global --state option before the subcommand.

Inspect the CLI

After installing the package, see the commands shipped in the preview:

python -m execution_core --help

The published v0.1.10 help lists worker, describe, mcp, dashboard, status-page, snapshot, submit, follow, get, cancel, logs, artifacts, artifact-read, list, status, dispatch, poll, call, and oidc.

Try the development fixture

Start the worker in one terminal. Synthetic fixtures do not need Docker:

mkdir -m 700 .execution-state
python -m execution_core --state "$PWD/.execution-state" worker --repository "$PWD"

In another terminal, use the same state directory. This exercises the CLI and local state without launching a workflow container:

python -m execution_core --state "$PWD/.execution-state" describe
python -m execution_core --state "$PWD/.execution-state" submit --backend development --key example-1 --delay-ms 500

Copy the run ID printed by submit, then inspect it:

python -m execution_core --state "$PWD/.execution-state" follow RUN_ID
python -m execution_core --state "$PWD/.execution-state" get RUN_ID
python -m execution_core --state "$PWD/.execution-state" logs RUN_ID --limit 1024

Run a workflow job

Stop the first worker with Ctrl-C. For workflow execution, restart it against a dedicated clone and provide an operator-built, digest-pinned image. Docker must be available to the worker.

python -m execution_core --state "$PWD/.execution-state" worker \
  --repository "$PWD/clone" \
  --runner-image registry.example/runner@sha256:IMAGE_DIGEST

In another terminal, submit one workflow job with the event JSON your workflow expects. This example assumes the workflow and job IDs exist in the clone:

python -m execution_core --state "$PWD/.execution-state" submit \
  --key local-check-1 \
  --workflow .github/workflows/check.yml \
  --job-id check \
  --event '{}'

Use follow RUN_ID and logs RUN_ID as above. The workflow submit requires --workflow, --job-id, and --event; --image is optional when the worker's --runner-image applies. For owner-repository polling and GitHub status reporting, see Security model and the exact options in poll --help and status --help.

Image placeholderReplace the example image with an image you built and pinned by digest. Rookrunner does not build, pull, or publish the worker's runner image for you.