Quick start
Begin with the quick start. You can install TestLookup from the ready-made container images with one command, or build the demo from a copy of the source code. Then sign in and send your first test report. Treat this first install as one you can throw away until you’ve seen an upload become a finished test run.
User workflows
The workflow guide follows a test result from upload to a saved run, then through analysis, review and the release decision. The concepts guide explains how runs, uploads, AI analysis, reports, reviews and release decisions fit together. That helps when one of them seems out of step with another.
To send results, see the guide to sending results. To understand the numbers, see reports and metrics.
Your own installation has a user guide built into the app, separate from this website. In a default local install, it’s at http://localhost:3000/docs. The interactive API reference is at http://localhost:8000/api-docs.
The guide for operators and administrators in the repository covers running and setting up an installation. It includes administration, connecting your continuous integration (CI) system, rules for quarantine and release checks, sizing, installs without internet access and troubleshooting.
Integrations
The integration guide covers the credentials, retries and delivery for each integration, such as Jira, GitHub, GitLab, notifications and outgoing webhooks. The client guide explains what each tool does: the test reporters for your test frameworks, the command-line tool and the MCP server for AI assistants.
Each integration still has to be set up in your installation, with its credentials and permissions, before it does anything.
Operations
Use the deployment guide to see how the services fit together and the order for database updates. Use storage and backups for what to back up and restore together. Use day-two operations for health checks, queues and routine maintenance.
After you deploy, check three things: the background workers are running, the database updates have finished, and one upload turns into a finished report. An API that responds isn’t enough on its own. When something goes wrong, start with troubleshooting.
The deployment guide links to one page for each way of installing, and to the upgrade steps for each version.
API
The API reference is generated from the OpenAPI document for this version of TestLookup. It flags endpoints whose response or sign-in details are incomplete. Use it as a list of what the API promises, not as proof of how a running server behaves.
Which version these pages describe
This site calls the documentation for the current development version next. The pages were written from one recorded point in the source code, and they don’t describe a released product version. TestLookup is early, pre-1.0 software, so expect some bugs and changes.
Copy commands and field names from these pages. Check them again when the pages are updated for a newer version of the code.
Where these pages come from
Each guide links to the files on GitHub that it was written from. If a page disagrees with an older note in the repository, follow the page, and please report the difference on GitHub. To see every guide for this version, open the list of guides. To find a topic quickly, use search.
Open the documentation index in the repository.
Read the repository’s development guide, testing guide and API guide.