# SquidCI

> SquidCI is CI/CD for GitHub repositories whose builds run in the customer's own AWS account. A repository describes its builds, tests and deploys in `.squidci/pipelines.yaml`; SquidCI runs them on workers in an execution plane the customer installs, reports them to GitHub as checks, and deploys to environments in order.

Every page below is Markdown at the link given. The whole of the docs in one file:
https://squidci.com/llms-full.txt. The pipeline file's JSON Schema, to check a file before pushing it: https://squidci.com/schema/pipelines.json.

## Start here

- [SquidCI](https://squidci.com/docs/index.md): What SquidCI is, how its pieces fit, and where to start — for people and for the coding agents working beside them.
- [Getting started](https://squidci.com/docs/getting-started.md): From signing up to a first green run — create an organization, connect an AWS account and GitHub, add a pipeline file, and push.
- [Set up with a coding agent](https://squidci.com/docs/with-an-agent.md): Prompts to give Claude Code or another coding agent so it writes and checks your pipeline file, a snippet for CLAUDE.md or AGENTS.md, and the SquidCI plugin for Claude Code.

## Concepts

- [How SquidCI works](https://squidci.com/docs/concepts/overview.md): The parts of SquidCI and how a push becomes jobs — organizations and regions, execution planes, runs, components, sections and jobs, checks and environments.
- [Execution planes and worker groups](https://squidci.com/docs/concepts/execution-planes.md): The stack SquidCI runs builds in, inside your AWS account — connecting it, worker groups on EC2 or Lambda, sizing, spot, warm pools and schedules, and keeping it current.
- [Environments and deploys](https://squidci.com/docs/concepts/environments.md): How versions reach environments — declaring environments and their order, AWS access per environment, deploying every version, on a schedule after a soak, or by hand, and rolling back.

## Pipelines

- [Writing a pipeline](https://squidci.com/docs/pipelines/guide.md): A walk through .squidci/pipelines.yaml — components and sections, steps, running in order with needs, passing artifacts and values between jobs, services, runners and caching.
- [Pipeline file reference](https://squidci.com/docs/pipelines/reference.md): Every setting of .squidci/pipelines.yaml — components, sections, steps, runner, services, aws, needs, after, paths, artifacts, cache and environments — with its values, defaults and limits.
- [AWS access for jobs](https://squidci.com/docs/pipelines/aws.md): How a job reaches the AWS accounts it deploys to — target AWS accounts, the ci role and its trust policy, profiles and regions in the pipeline file, and what pull requests get.

## More

- [Security](https://squidci.com/docs/security.md): What the SquidCI stack creates in your AWS account, the one permission it opens to SquidCI, what SquidCI holds and what it never sees, and how jobs are isolated.
- [Slack](https://squidci.com/docs/slack.md): Post deploys and default-branch failures to Slack channels — adding the SquidCI app to a workspace, choosing channels by ID, and what gets posted.