cruise 0.1.78

YAML-driven coding agent workflow orchestrator
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
# Examples

Companion files for [`docs/github-actions.md`](../docs/github-actions.md). See that doc for the full command reference, setup steps, inputs/outputs, and security notes.

| File | Use it when... |
|---|---|
| [`cruise.yml`]cruise.yml | You want the baseline setup: Anthropic (or OpenAI) via the dedicated `anthropic_api_key`/`openai_api_key` inputs, no custom model or config. Start here. |
| [`cruise-kimi.yml`]cruise-kimi.yml | You want to drive cruise with [Kimi for Coding]https://api.kimi.com/coding/, a pi built-in provider authenticated by `KIMI_API_KEY`. Mirrors this repository's own dogfood workflow (`.github/workflows/cruise.yml`). |
| [`cruise-openai-compatible.yml`]cruise-openai-compatible.yml | Your models live behind OpenAI-compatible or Anthropic-compatible endpoints not already known to pi. Uses the `providers`/`provider_api_keys` inputs, which now cover headers, `compat`, per-model metadata, and keyless (`no_auth`) endpoints too; `pi_models_json` remains available as a raw overlay for whatever `providers` still doesn't express. |
| [`repo-cruise.yaml`]repo-cruise.yaml | You want to commit your own cruise workflow config (`sdk: pi`, `write-tests -> implement -> test` with a fix-and-retry loop) instead of relying on the action's generated default. Copy it to your repository root as `cruise.yaml`. |

All three `cruise*.yml` files are complete, drop-in `.github/workflows/cruise.yml` replacements -- pick one, copy it, and fill in the secrets it references. `repo-cruise.yaml` is not a GitHub Actions workflow; it's a cruise config file that lives alongside your project's own source.