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 flows Four 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. Upload CI sends screenshots circi upload Compare The worker diffs each one against the baseline Review People approve or reject in the dashboard Merge gate Approval decides passes when approved How a build flows Four 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. Upload CI sends screenshots circi upload Compare The worker diffs each one against the baseline Review People approve or reject in the dashboard Merge gate Approval decides passes when approved
Highlighting a stage:
How a build flows Four 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. Upload CI sends screenshots circi upload Compare The worker diffs each one against the baseline Review People approve or reject in the dashboard Merge gate Approval decides passes when approved How a build flows Four 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. Upload CI sends screenshots circi upload Compare The worker diffs each one against the baseline Review People approve or reject in the dashboard Merge gate Approval decides passes when approved
Create a project. Use the dashboard.
Copy its token. Store it in your CI secrets as CIRCI_TOKEN.
Run the upload.
$ npx @circi/cli upload ./screenshots --waitCopy
Note
An Aside indented under its step stays inside the step: use it for a warning that belongs to that one action. Anything longer than a short paragraph ends the list: close </Steps>, write the text, and open a new <Steps> that continues the numbering with the start attribute of the list.
Open the build.
Note
A note is information, in the processing color.
Tip
A tip is something that went right, in the approved color.
Caution
A caution needs a decision, in the needs review color.
Danger
A danger breaks something, in the failed color.
Press ⇧ Shift A A to approve everything, or ⌘ Command K K for the command menu. A sequence uses "then": g g then i i opens the Inbox.
PUBLIC_URLURL Default 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 Close Esc
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 Close Esc
aspect="16 / 7" keeps the top of the capture.
A themed, accessible inline SVG: draw with the d-* classes.
docker compose up -d --build
circi upload ./screenshots --wait