Dashboard Guide

The ShipTested dashboard gives you full visibility into your test generation results, coverage trends, and project settings. This guide walks through every view and what you can do in each one.

Project Overview#

The project overview page is your home base for each project. Access it at /p/[slug] after creating a project.

What you will see#

• Stats cards - total files tested, total runs, overall coverage percentage, and detected tech stack
• Coverage trend chart - a visual history of your coverage over time, so you can track progress across runs
• Recent runs - the last 5 runs with status, file count, and coverage at a glance
• Files needing attention - files with failing or errored test generations, surfaced so you can address them first

The project slug is derived from your package.json name field. You can also find it in the URL when viewing your project.

Files View#

The files view at /p/[slug]/files shows every source file that ShipTested has generated tests for.

Search and filter#

Use the search bar to find files by name or path. Filter by status to narrow down to specific results:

• Passed - all generated tests are passing
• Failed - some or all tests failed after max iterations
• Skipped - file was skipped (e.g. type-only file, barrel export)

Directory grouping#

Files are grouped by their directory path, making it easy to browse large projects. Each file entry shows its current status, the number of iterations used, and coverage percentage.

File Detail#

Click any file in the files view to open its detail page at /p/[slug]/files/[filePath]. This is where you get the full picture of a single file's test generation.

Detail sections#

• Status and metadata - current status, number of iterations, coverage percentage, and tokens used
• Iteration log - expandable timeline showing what happened at each iteration: how many tests passed, what errors occurred, and what fixes were applied
• Generated test content - the full test file with syntax highlighting, ready to copy into your project
• Error output - if the file ended in a failed state, the error details are shown here
• Generation history - previous generation attempts for this file across different runs

Runs View#

The runs view at /p/[slug]/runs lists every test generation run for your project, ordered by most recent first.

Filtering#

Filter runs by:

• Branch - see runs from a specific git branch
• Trigger type - distinguish between manual CLI runs, CI/CD runs, and scheduled runs

Run list columns#

Each run shows:

• Trigger source (CLI, CI, scheduled)
• Number of files processed
• Overall status (passed, failed, partial)
• Coverage percentage
• Timestamp and duration

Run Detail#

Click a run to see its detail page at /p/[slug]/runs/[runId]. This gives you a complete breakdown of what happened during that run.

Run summary#

• Files processed - total number of files included in the run
• Succeeded - files where all generated tests pass
• Failed - files that still have failing tests after all iterations
• Skipped - files that were excluded or deemed un-testable
• Coverage - aggregate coverage percentage for the run

File results#

Below the summary, each file result is listed with expandable iteration logs. You can drill into any file to see its full detail page.

Project Settings#

The settings page at /p/[slug]/settings lets you view and manage your project configuration.

Project info#

• Project name - derived from your package.json
• Slug - URL-safe identifier (read-only)
• Default branch - the primary branch for your project (read-only)

Detected configuration#

Shows the auto-detected settings from your project: language, framework, test framework, and module system. These are set during shiptested init and used during test generation.

Custom instructions#

Add custom instructions that will be included in the prompt when generating tests for this project. Use this to specify coding conventions, preferred mocking strategies, or any project-specific context that helps produce better tests.

Custom instructions are available on Pro and Team plans.

Delete project#

At the bottom of the settings page, you can permanently delete a project and all its associated data (runs, file results, coverage history). This action cannot be undone.

Billing and API Keys#

The billing page at /settings/billing manages your subscription, usage, and API keys.

Usage overview#

See your current month's usage at a glance:

• Files used / limit - how many files you have generated tests for versus your plan limit
• Tokens consumed - total input and output tokens used for AI generation
• Runs count - number of generation runs this month

API key management#

Create, list, and revoke API keys from this page. API keys are used for CI/CD authentication and headless environments where OAuth is not practical.

• Keys use the sk_live_ prefix format
• The full key is shown only once at creation. Copy it immediately.
• You can name keys for identification (e.g. "GitHub Actions", "laptop")
• Revoke a key at any time to disable it

For details on using API keys in CI, see the CI/CD Integration guide.

Stripe billing portal#

Click the billing portal link to manage your subscription through Stripe. From there you can upgrade or downgrade your plan, update payment methods, and view invoices.

Next Steps#

• CI/CD Integration - automate test generation in your pipeline
• Pricing - compare plans and features
• Configuration - customize test generation for your project