TestRail Hover
View TestRail case details directly in VS Code by hovering over case IDs such as C1849545.
Features
- Shows case title, priority, type, status, suite, section, and other available details.
- Displays preconditions, numbered steps, expected results, and custom fields in a readable format.
- Converts TestRail-formatted content into clean text.
- Includes a link to open the case in TestRail.
- Works across all projects available to the configured TestRail account.
- Reuses recently viewed cases and lookup information to keep hovering fast.
- Handles slow responses and temporary TestRail rate limiting automatically.
Getting started
- Install the extension from a
.vsix file or the VS Code Marketplace.
- Open a code file containing a TestRail case ID.
- Open the Command Palette with
Cmd+Shift+P.
- Run
TestRail Hover: Configure connection.
- Enter your TestRail HTTPS base URL, username/email, and API key.
- Hover over a case ID such as
C1849545.
Commands
TestRail Hover: Configure connection — save or replace the TestRail connection.TestRail Hover: Clear cache — remove cached case details and lookup information.TestRail Hover: Delete saved configuration — remove the saved connection and cached data.
Settings
Open VS Code Settings and search for TestRail Hover.
| Setting |
Default |
Description |
testrailHover.cacheTtlMinutes |
1440 |
How long case details are reused before they are refreshed, in minutes. |
testrailHover.cacheMaxEntries |
200 |
Maximum number of case details kept for quick reuse. |
testrailHover.persistMetadata |
true |
Keep lookup names such as projects, suites, users, and priorities between VS Code sessions. |
testrailHover.requestIntervalMs |
250 |
Minimum time between TestRail requests, in milliseconds. Allowed range: 100–5000. |
Set testrailHover.persistMetadata to false when lookup information should not be retained between sessions.
Privacy and security
- The API key is protected by VS Code and is never included in cached case or lookup data.
- Cached data is scoped to the configured TestRail account and base URL.
- Use a TestRail account with only the permissions required for viewing cases.
License
MIT
| |
