Quickstart

1. Initialize Bellows

1bellows init

This creates .bellows.yml with detected default workflows and runner mappings. Preview the generated config first with:

1bellows init --dry-run

To also create a pre-push hook entry:

1bellows init --pre-commit

2. Inspect Compatibility

1bellows doctor

Doctor reports:

• discovered workflows and jobs;

• runner labels and local Docker image mappings;

• dynamic runner expressions such as ${{ matrix.os }};

• missing act or Docker dependencies;

• known local compatibility warnings.

Use strict mode when warnings should block the local check:

1bellows doctor --strict

Use safe fixes to add known runner mappings and local skip recommendations:

1bellows doctor --fix

3. Run a Workflow

Run the default workflow:

1bellows run

Preview the execution plan without Docker:

1bellows run --list

Run a specific workflow:

1bellows run --workflow ci.yml

Run a specific job:

1bellows run --workflow ci.yml --job test

4. Enable Pre-Push

If you initialized with --pre-commit, install the pre-push hook:

1pre-commit install --hook-type pre-push

Then Bellows runs before pushes:

1git push