Set up with your coding agent

One file your coding agent follows end to end: install, account, workspace, the product map, state-asserting journeys, a first run and the check on every pull request — with a verification after each step.

Hand it over

Most teams let an agent (Claude Code, Cursor, Codex, a CI bot) do the setup. The instructions it needs are one Markdown file, written for an agent: ordered steps, the exact commands, what to verify after each one, and where to stop and ask a human. Point your agent at it:

A prompt for your agent
Read https://www.simulithic.com/docs/onboard-with-your-agent.md and follow it step by step for this repository.
Invite code: SIM-XXXX-XXXX. Account email: you@company.com.
The product is a web app at https://app.example.com with Vercel preview deployments (or: a Mac app built by `npm run dist` into dist/mac-arm64/App.app).

The file is plain Markdown at simulithic.com/docs/onboard-with-your-agent.md; fetch it withcurl, or paste it into the conversation.

What the agent needs from you

  • Your invite code and the email the account should use.
  • Whether the product is a web app (production URL, and how previews are made: Vercel, a staging URL, or a local dev server) or a native app (Mac .app, iOS simulator .app, Android .apk) and the CI step that builds it.
  • If the product has a login: a test account whose data may be touched. Never a real customer’s or an admin’s.
  • A password for the new account, typed at a prompt — or, for an agent without a terminal, exported as SIMULITHIC_PASSWORD for the one command that needs it.

What the agent does

  1. Installs the CLI and creates the account and workspace.
  2. Stores the test sign-in (asks you to do it in the Studio).
  3. Maps the product: the explorer walks every page or screen and writes the journeys (about ten minutes for an app).
  4. Reads the journeys and adds ones that assert state: a change must still be there after a reload or an app relaunch, with a value only that person knows. See Pull request checks for why this matters.
  5. Runs one simulation by hand and cleans the baseline until every journey passes on the release.
  6. Mints the CI token, adds the workflow (web previews or native builds), pushes it and opens a first pull request.

In our own rehearsal an agent with nothing but this file went from zero to a green check on its first pull request in 33 minutes, 12 of them for the map and 10 for the check itself.