Meticulous Onboarding Guide
Set up Meticulous in this order:
- Connect the repository to Meticulous.
- Choose automated CLI onboarding or manual setup.
- Record sessions and confirm Meticulous runs on pull requests.
Connecting the repository first lets Meticulous identify the base and head versions of each pull request or merge request and publish its test result in the right place.
1. Connect your repository
Create your Meticulous organization and project, then connect the Git provider that hosts the repository. Do this before installing the recorder or configuring CI.
- Sign in to Meticulous and create or select your organization.
- Choose Connect to GitHub when creating the project.
- Install the Meticulous GitHub App for the organization and repositories you want Meticulous to test.
- Return to Meticulous, select the repository, and create the linked project.
Once the linked project exists, choose how you want to install Meticulous.
2. Choose your setup path
Automated setup with meticulous onboard
meticulous onboard uses Claude Code or Codex on your machine to inspect the application and prepare a pull request containing the recorder and CI configuration. Meticulous does not host the model inference; the command uses your existing Claude Code or Codex account.
Prerequisites
- Run the command from a clone of the connected Git repository.
- Install and authenticate Claude Code or Codex.
- Use Node.js 20 or newer.
Run onboarding
From the application repository. If you are not logged in, the command opens a browser to sign in, then continues:
npx @alwaysmeticulous/cli onboard --project="<ORGANIZATION>/<PROJECT>"
On a remote machine where a browser cannot reach this terminal, sign in first with device login, then re-run onboard:
npx @alwaysmeticulous/cli auth login --device
It asks you to choose the frontend application in a monorepo and the local coding agent, reviews the repository, proposes a plan for approval, and then opens a setup pull request.
After the pull request is ready:
- Review and merge the recorder and CI changes.
- Add any requested API token to your CI provider's secret store.
- Record a representative session.
- Open a pull request and confirm that Meticulous reports a result.
3. Verify the complete setup
Setup is complete when:
- The project is linked to the correct GitHub, GitLab, or Bitbucket repository.
- At least one representative session reaches Meticulous.
- A session replays successfully against your application.
- The default branch has a baseline test run.
- A pull request or merge request produces a Meticulous result.
If something fails, start with recorder troubleshooting or the FAQ and troubleshooting guide.
After the first successful run, make the Meticulous check blocking and reduce false-positive diffs.