Quick Start Guide

This guide is the hands-on path for the workflow summarized in What is TestChimp?: wire your repo to TestChimp, install the skill and MCP, run one-time init, then use /testchimp test on each PR.

Before you begin

A TestChimp account and project (see Onboarding if you need team/project setup).
Node.js and a supported test toolchain where the agent runs tests: Playwright for web and Mobilewright for native mobile (the skill documents minimum versions). Mobile-specific CI guidance: Mobile testing.
A TESTCHIMP_API_KEY for the project (from Project settings in TestChimp), set both in MCP config and in the shell when running Playwright—see /testchimp init.

Step 1: Map your repository in TestChimp (Git)

In TestChimp → your project → Project settings → Integrations → Git, select the Git repository for this product.
Map two folders in that repo:
- Tests — SmartTests root: where your UI suite runs (for example npx playwright test on web or npx mobilewright test on native mobile) and .testchimp-tests lives after sync.
- Plans — Markdown test plans root: stories, scenarios, knowledge; .testchimp-plans lives here after sync.
Complete the product sync so marker files and any scaffold land in Git, then pull the branch locally.

Why two folders: Plans carry intent (what to verify); tests carry automation (how you verify it). Agents and MCP use both. Details: Git integration.

Step 2: Install the TestChimp skill

Install the TestChimp skill on your agent host (Claude Code, Cursor, or any environment that loads skills—follow that host’s skill directory layout).

Restart the IDE or agent host if the skill does not load immediately.

Step 3: Register MCP (`@testchimp/cli`)

The skill drives QA through MCP tools (coverage, planning, environments, TrueCoverage, …). Register @testchimp/cli in your MCP config (for example .cursor/mcp.json) with TESTCHIMP_API_KEY in the server env. Use the skill’s sample config as a template; pin or use @latest per your team policy—see /testchimp init — Dependencies and reporter.

Step 4: Run `/testchimp init`

In the agent chat, run /testchimp init once per repository.

Init establishes the QA harness: web Playwright layout and @testchimp/playwright, or a native mobile scaffold per project type—see Mobile testing—plus CI wiring, seed / teardown / read strategy, fixtures, mocking approach, environment strategy (local, staging, or Bunnyshell if you use it—see Bunnyshell integration), optional TrueCoverage instrumentation (web, iOS, Android — see Instrumenting your app), and writes project decisions to plans/knowledge/ai-test-instructions.md where applicable.

Full narrative: Init.

Step 5: Run `/testchimp test`

When implementation on a PR is ready, run /testchimp test.

The agent aligns with plans under your mapped plans/ tree, uses MCP for insights, updates tests, fixtures, and seeds as needed, and links automation to scenarios (for example // @Scenario: comments). If you are not on a PR, give a focus area (story, folder, or scenario scope).

Full phase breakdown: Test.

After you are running

Next	When
`/testchimp evolve`	On a cadence or after deploys—portfolio-level improvement across requirements, execution history, and real usage (optional ExploreChimp on high-signal UI paths).
`/testchimp explore`	ExploreChimp as the primary task—targeted UX analytics on chosen UI SmartTests (`markScreenState`, env flags).
CI	Keep `@testchimp/playwright` so runs report to TestChimp and attach test identity for TrueCoverage (web and native when RUM is wired)—see Runtime plugin and Instrumenting your app. Native mobile: prefer `mobile_use_api_key` with cloud devices (Mobile Use)—see Mobile testing.
Web app	Author or refine plans, review coverage and bugs, configure integrations.

Before you begin​

Step 1: Map your repository in TestChimp (Git)​

Step 2: Install the TestChimp skill​

Step 3: Register MCP (@testchimp/cli)​

Step 4: Run /testchimp init​

Step 5: Run /testchimp test​

After you are running​

See also​