docs
Project configuration reference
See which Test Chronicle settings belong in the repository, on the local machine, in the dashboard, and in CI.
Updated 2026-06-06
Repository project file
The login command writes testchronicle.config.json in the Git repository root:
{
"projectId": "your-project-id"
}
This non-secret file links sync commands from the repository to a Test Chronicle project. It does not control framework detection, test directories, or file patterns.
Local credentials
The CLI stores the project-scoped token in your user configuration directory, outside the repository. Do not add that token to source control.
Run npx testchronicle@latest status to check the current authentication and project connection. Run npx testchronicle@latest logout to remove the stored credentials.
Dashboard sync settings
Test Chronicle detects frameworks and conventional test locations automatically. When a repository needs an override, use its project settings in the dashboard to:
- Set framework-specific test directories.
- Exclude test directories that should not be parsed.
- Set the default branch.
- Choose the primary framework shown for the project.
Run a local sync after changing these settings and check the resulting tests and files before relying on CI updates.
GitHub Actions
The GitHub Action accepts API_KEY and PROJECT_ID. Store both as GitHub Actions secrets. Environment values supplied to the action take precedence over local credentials and the repository project file.
Related reading
See it in Test Chronicle
Inspect a populated project or start tracking your own repository history.
Create a free account