Skip to main content

Quick Start Guide

In brief: Connect Git, install the TestChimp skill and MCP, run /testchimp init once—then use the two composite workflows day to day: /testchimp run QA on each PR, and /testchimp upkeep on a cadence.

This guide is the hands-on path for the model in What is TestChimp?. After setup, you do not invent ad-hoc agent prompts for every QA task—you run pre-defined workflows: battle-tested playbooks in the skill, customized by project policies in your repo.

Day-to-day shape:

CadenceComposite workflowSynonyms
When a PR / change is readyRun QA/testchimp run QA, /testchimp test
On a schedule or after deploysUpkeep/testchimp upkeep, /testchimp evolve

Each composite chains modular subflows (author plans, connect env, create tests, smart smoke, ExploreChimp, TrueCoverage, cleanup, …) under one approved plan and one scope. You can also invoke those atomic workflows on their own when you only need one job. Full catalog, policies, and scoping rules: Workflows.

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)

  1. In TestChimp → your projectProject settingsIntegrationsGit, select the Git repository for this product.
  2. 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.
  3. 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, MCP, and workflow policies use both. Details: Code Repository — Overview.

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). Keep a git clone so you can pull updates or run /testchimp skill upgrade.

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

Step 3: Register MCP (@testchimp/cli)

Workflows call TestChimp through MCP tools (coverage, planning, environments, TrueCoverage, policies, …). Register @testchimp/cli in your project 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 seeds default composite policies (run-qa.policy.md, upkeep.policy.md) under plans/knowledge/policies/, with project decisions in plans/knowledge/ai-test-instructions.md where applicable.

Full narrative: Init.

Step 5: Run QA on each PR

When implementation on a PR (or change set) is ready, run the Run QA composite:

/testchimp run QA
/testchimp test
/testchimp run QA for checkout

The agent follows the run-qa playbook and your run-qa.policy.md: typically author or update plans for the scope, connect the test environment, create or repair SmartTests and fixtures, run smart smoke, optionally ExploreChimp on new UI journeys, and advance TrueCoverage—under one approved plan and one workflow_execution_id. If you are not on a PR, pass an explicit focus area (story, folder, or scenario scope).

Details and default subflows: Run QA. Broader model (composites vs atomic workflows, policies, scoping): Workflows.

Step 6: Run upkeep on a cadence

Periodically (for example weekly) or after deploys, run the Upkeep composite:

/testchimp upkeep
/testchimp evolve

Upkeep is portfolio maintenance—not the per-PR loop: close requirement and TrueCoverage gaps, targeted ExploreChimp on high-signal paths, cleanup, and instrumentation updates. Customize via upkeep.policy.md.

Details: Upkeep.

After you are running

NextWhen
Atomic workflowsNeed one job only—e.g. Create tests, ExploreChimp, Fix coverage gaps, Connect to test env—see the Workflows catalog.
PoliciesTune smoke vs full composites, skip ExploreChimp, pin env rules—/testchimp create policy and Workflows — Policies.
CIKeep @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 appAuthor or refine plans, review coverage and bugs, configure integrations, watch Workflows execution history.

See also

  • What is TestChimp? — Positioning and “why not just Claude”.
  • Workflows — Composites, atomic workflows, policies, and traceability.
  • Run QA / Upkeep — The two common composite flows.
  • SmartTests — Playwright on web + optional ai.* steps (web today).
  • Mobile testing — Native iOS / Android with Mobilewright.
  • Chrome extension — Optional manual session capture (scenario-linked or open-ended, with notes and bugs), then Copy test generate prompt for agent-authored SmartTests; recommended day-to-day path for test and infra work is still skill + workflows.

FAQ

What do I need before starting?

A Git repository, a TestChimp project, and an agent host (Claude Code, Cursor, etc.) with the TestChimp skill and MCP wired via @testchimp/cli.

Which folders should I map in TestChimp?

Map one folder for markdown test plans (e.g. plans/) and one for SmartTests (e.g. tests/) so agents and CI share the same source of truth.

How long does initial setup take?

Most teams complete Git mapping and /testchimp init in under a day; first PR-scoped tests often land within the same sprint.