Getting started with Test Chronicle

1. Create an account and project

Create a free Test Chronicle account, open the dashboard, and create the project you want to track.

Before linking a repository, review how repository access and synced metadata are handled.

2. Open the repository locally

Run the Test Chronicle CLI from the root of the Git repository containing your tests:

npx testchronicle@latest login

Complete authentication in the browser, then return to the terminal and select the project. The CLI writes its non-secret project identifier to testchronicle.config.json. Your project token is stored in your user configuration directory, outside the repository.

3. Run the first sync

From the repository root, run:

npx testchronicle@latest sync

The agent detects supported frameworks, parses test files, and walks up to 365 days of Git history on the first sync.

4. Inspect the dashboard

Open the project to review the summary, timeline, contributors, tests, files, and Health Score views.

5. Automate future updates

Once the local workflow produces the expected data, add the Test Chronicle GitHub Action to your CI workflow. Later syncs use the saved commit marker and process new history instead of repeating the initial window.