Appearance

Quickstart ​

From zero to your first uploaded run in about five minutes. The example is a pnpm repository with Vitest; other runners work the same way.

1. Create a project ​

Sign in to the EasyTrace dashboard with GitHub, open Projects → New project, and give it a name and its main framework.

The project's Setup tab shows its project token (et_proj_…). You only need it for CI — skip it for now.

2. Install the CLI ​

bash
pnpm add -D @easytrace/cli

Private preview

While the CLI isn't on npm yet, install it from GitHub instead — see Install the CLI.

3. Sign in from your machine ​

bash
pnpm exec easytrace login

The CLI prints a code and opens your browser. Check that the code on the page matches your terminal, then click Authorize. The terminal prints Signed in as @you on https://api.easytrace.dev.

4. Describe the repository ​

bash
pnpm exec easytrace init

init asks for the organization and project, then suggests suites from your dependencies (vitest → unit, @playwright/test → e2e, jest → unit). It writes easytrace.config.json at the repository root:

json
{
  "project": "01933c2e-5f0a-7cc1-9a4e-2b1d9f3e6a10",
  "suites": {
    "unit": { "reports": ".easytrace/vitest.json" }
  }
}

Commit this file — it contains no secret. Add .easytrace/ to .gitignore.

5. Make the tests write a report ​

json
{
  "scripts": {
    "test:report": "easytrace run -- vitest run --reporter=default --reporter=json --outputFile.json=.easytrace/vitest.json"
  }
}

--reporter=default keeps the usual terminal output; the JSON reporter writes the file EasyTrace reads.

6. Run ​

bash
pnpm test:report

The tests run as usual. When they finish, the CLI uploads the report and prints a link:

text
Uploaded 1 failed, 212 passed from 1 file (suite unit) → https://app.easytrace.dev/app/runs/…

The command exits with your tests' exit code, so it can replace pnpm test anywhere.

Next steps ​