User guide
KiCI runs your CI/CD on infrastructure you control — your own orchestrator and agents clone the code and run every job, while the hosted platform relays webhooks and renders the dashboard without ever seeing your source or secrets. You author workflows in real, typed TypeScript and run them locally before you push, so the pipeline you test on your laptop is the pipeline that runs in production. This section is for the people writing those workflows.
Start here
Section titled “Start here”- Green run in ~5 minutes — stand up an orchestrator and agent (Docker / Podman or bare metal) and watch your first workflow go green.
- Getting started — install the SDK and compiler, write your first workflow, compile it to a lock file, and test it locally with simulated events.
- Why KiCI — the case for running CI on your own infrastructure with typed TypeScript workflows.
- GitHub App provider — connect your first source and route real pull-request and push events.
What’s in the user guide
Section titled “What’s in the user guide”- Authoring — the SDK reference covers every factory function, trigger, rule, and matrix option; workflow patterns show monorepo builds, conditional jobs, dynamic matrices, and scheduling; how your workflow code executes maps compile, orchestrator, and agent time.
- Running and testing — the CLI reference documents every command; the testing guide covers
kici run remote, fixtures, and overlay mode; the dashboard is the web UI for watching runs. - Wiring sources — the GitHub App and universal-git providers connect your forge; global workflows run cross-repo.
- Configuration and secrets — contexts, secrets, dynamic values, concurrency groups, lifecycle hooks, and environment variables.
The left sidebar is the full index for the user guide — every page in curated reading order.