Ask the Community
Connect to Zephyr
Connect Zephyr to Test Companion to access your test repository within your IDE. Fetch test steps directly into your workspace to generate automation scripts instantly.
Zephyr test cases act as the definitive source for acceptance criteria, edge cases, and detailed steps essential for testing. By integrating Zephyr directly into the Test Companion interface, you can browse and fetch these test cases without leaving your IDE or manually copying links.
This integration establishes a direct connection to your Zephyr folders, allowing you to generate automation scripts for existing test cases instantly.
Currently, only Zephyr Scale is supported for test case automation.
Prerequisites
Before you start, confirm these:
- Install Test Companion in your IDE and sign in.
- You must have a valid Zephyr Scale subscription.
- Complete the Zephyr integration flow to connect your Zephyr account.
Automate from Zephyr
After you connect, browse your test repository directly within the IDE.
Currently, you can only automate individual test cases from Zephyr Scale from the UI.
Select Project and Folder
-
Open Test Companion and navigate to the Test Management pane by clicking the Test Cases icon (book icon) in the activity bar.
-
In the Test Management Service dropdown, ensure Zephyr Scale is selected.
-
Use the dropdown menus in the Test Cases pane to navigate your repository:
- Project: Select the Zephyr Scale project where your test cases reside.
- Folder: Browse the folder structure (tree view) to find specific test suites.
View test cases
- Click a folder to display a list of all test cases contained within it. The list includes key details such as:
- Test ID (e.g., T-45)
- Test Name
- Pre-conditions
- Description
- Priority
In the test cases panel, steps are not shown in the table, but they will be retrieved when you click the Automate button for that specific test case.
Generate automation
To automate a specific test case:
- Locate the test case in the list.
-
Click the Automate button (or the generate action icon) next to the test case.
The test case details get populated in the Test Companion chat input.
- Click Send message (➤).
Test Companion will read the Test Steps, Expected Results, and Preconditions from Zephyr Scale and generate an automation script in the chat window tailored to your selected framework.
We're sorry to hear that. Please share your feedback so we can do better
Contact our Support team for immediate help while we work on improving our docs.
We're continuously improving our docs. We'd love to know what you liked
We're sorry to hear that. Please share your feedback so we can do better
Contact our Support team for immediate help while we work on improving our docs.
We're continuously improving our docs. We'd love to know what you liked
Thank you for your valuable feedback!