Skip to content

kiwamizamurai/vscode-testrail

Repository files navigation

TestRail VSCode Extension

Important

If you like this project, please consider giving it a star on GitHub or leaving a review on the Visual Studio Code Marketplace.

License: MIT VS Code Marketplace Version VS Code Marketplace Downloads VS Code Marketplace Rating VS Code Marketplace Installs

Seamlessly integrate TestRail into your VS Code workflow. View, edit, and manage test cases without leaving your IDE.

This is an open-source alternative to the Paid extension by Railflow.

logo

✨ Features

  • 🚀 Quick Access - One-click access to TestRail from VS Code
  • 🌳 Tree View Integration - Browse TestRail projects, suites, sections, and test cases in VS Code's sidebar
  • 📋 Test Case Management
    • View test case details with full markdown support
    • Create new test cases
    • Edit existing test cases
    • Delete test cases
    • Duplicate test cases
  • 📁 Suite Management
    • Create new test suites
    • Edit existing suites
    • Delete suites
  • 📂 Section Management
    • Create new sections
    • Edit existing sections
    • Delete sections
  • 🏃 Test Run Management
    • Create new test runs
    • Edit existing runs
    • Close runs
    • Delete runs
  • 📊 Test Result Management
    • Add test results
    • View test results history
  • 🔄 Drag and Drop Support - Easily reorganize test cases and sections

🚀 Installation

  1. Open VS Code
  2. Press Ctrl+P / Cmd+P
  3. Type ext install testrail-vscode

🔧 Setup

  1. Click the TestRail icon in the activity bar
  2. Click "Login" and enter your credentials:
    Host URL: https://example.testrail.io or https://example.tmxtestrail.com
    Email: [email protected]
    API Key:  Generate from TestRail > My Settings > API Keys
    
  3. (optional) Specify the project you want to use. (If you only use a specific project, select the project. otherwise, sidebar will show all projects)

🛠️ Development

Running & Debugging

  1. Clone the repository

    git clone https://github.com/kiwamizamurai/vscode-testrail.git
    cd vscode-testrail
  2. Install dependencies

    npm install
  3. Open in VS Code and press F5 to start debugging

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments