Ghost Inspector Visual Studio Team Services Plugin
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.

Ghost Inspector Extension for Visual Studio Team Services

Build status: build status

With this plugin you can add a build step to your VSTS project that executes a Ghost Inspector test suite. If the test suite is successful, your pipeline will continue to the next step in your pipeline; however, if it fails (or times out), the build will be marked as failed.


This plugin can be installed from within the Visual Studio Marketplace.


  • API Key - This is a unique, private key provided with your account which allows you to access the API. You can find it in your Ghost Inspector account settings at
  • Suite ID - The ID of the Ghost Inpsector suite that you would like to execute.


  1. Install the extension from Visual Studio Marketplace.
  2. Open your project within VSTS and navigate to Builds.
  3. In the Tasks section, click the + icon to add a new task.
  4. To find the extension in the list quickly, type Ghost in the search box and select Add.
  5. Click on the new task and fill in the required fields for Suite ID and API Key.
  6. If you would like to run your Ghost Inspector tests on a URL other than their default setting (such as a local build instance of your application using a tunnel), enter the start URL in the Start URL field.
  7. If you would like to pass other custom parameters or variables to your suite run, specify them in the Additional Parameters field using JSON (eg: {"browser":"chrome", "myVar":"some value"}).
  8. Save and queue your project.


The extension is written in TypeScript. Between changes, you can simply run the tests with:


Building the extension

First make sure you have the VSTS extension CLI:

$ npm install -g tfx-cli

You will need to increment the appropriate version number before you can build and publish this extension:

Create the extension with this command:

$ tfx extension create

The extension should now be in the project root under ghost-inspector.ghost-inspector-vsts-extension-<version>.vsix.


Please report any issues on Github or through our support channel.

Change Log

  • 2018-07-18 - 1.0.5: Add compatibility for TFS2017 (node v5.x/ES5)
  • 2018-04-03 - 1.0.4: Fix parameters typo
  • 2018-03-15 - 1.0.2: Add CI config and public build status
  • 2018-03-13 - 1.0.1: Patch to fix not passing startUrl
  • 2018-02-26 - 1.0.0: Initial release