Skip to content

Design kit

The components that section pages use, kept out of the sidebar and the search index.

Needs review Approved Rejected Flaky Failed Processing Auto-approved Added Removed Unchanged

A glyph alone, inline: a screenshot passes and fails on the same commit. With your own words: 3 approved.

How a build flowsFour stages in order. Upload: CI sends screenshots with circi upload. Compare: the worker diffs each screenshot against the baseline. Review: people approve or reject changes in the dashboard. Merge gate: the check on the pull request, or the CI job when no repository is linked, passes once everything is approved.UploadCI sends screenshotscirci uploadCompareThe worker diffs each oneagainst the baselineReviewPeople approve or rejectin the dashboardMerge gateApproval decidespasses when approvedHow a build flowsFour stages in order. Upload: CI sends screenshots with circi upload. Compare: the worker diffs each screenshot against the baseline. Review: people approve or reject changes in the dashboard. Merge gate: the check on the pull request, or the CI job when no repository is linked, passes once everything is approved.UploadCI sends screenshotscirci uploadCompareThe worker diffs each oneagainst the baselineReviewPeople approve or rejectin the dashboardMerge gateApproval decidespasses when approved

Highlighting a stage:

How a build flowsFour stages in order. Upload: CI sends screenshots with circi upload. Compare: the worker diffs each screenshot against the baseline. Review: people approve or reject changes in the dashboard. Merge gate: the check on the pull request, or the CI job when no repository is linked, passes once everything is approved.UploadCI sends screenshotscirci uploadCompareThe worker diffs each oneagainst the baselineReviewPeople approve or rejectin the dashboardMerge gateApproval decidespasses when approvedHow a build flowsFour stages in order. Upload: CI sends screenshots with circi upload. Compare: the worker diffs each screenshot against the baseline. Review: people approve or reject changes in the dashboard. Merge gate: the check on the pull request, or the CI job when no repository is linked, passes once everything is approved.UploadCI sends screenshotscirci uploadCompareThe worker diffs each oneagainst the baselineReviewPeople approve or rejectin the dashboardMerge gateApproval decidespasses when approved
  1. Create a project. Use the dashboard.

  2. Copy its token. Store it in your CI secrets as CIRCI_TOKEN.

  3. Run the upload.

    npx @circi/cli upload ./screenshots --wait
  4. Open the build.

Press ShiftA to approve everything, or CommandK for the command menu. A sequence uses "then": gtheni opens the Inbox.

PUBLIC_URLURLDefault http://localhost:3000

The address people open in the browser. It's also the base of every link CirCI sends.

BETTER_AUTH_SECRETRequired

Signs sessions. 32 characters or more.

CirCI
The build page for build #101.
A real dashboard screenshot, in the reader's theme.

The frame takes the capture's own ratio, so it always fits the image. aspect crops a tall capture to a shorter box (it keeps the top of the page) and is ignored when it would be taller than the image; images load lazily and reserve their box, so long pages don't jump.

CirCI
The top of the build page, cropped.
aspect="16 / 7" keeps the top of the capture.
Two boxesA request box with an arrow to a response box.RequestComes inResponseGoes out
A themed, accessible inline SVG: draw with the d-* classes.
Terminal
docker compose up -d --build
circi upload ./screenshots --wait