Testim Documentation

Welcome to the Testim documentation. You'll find comprehensive guides to help you get started quickly, example code snippets, and tips for being more productive. You will also find details about advanced features that allow you to customize Testim to fit your environment or special testing conditions. Don't worry, we'll support you if you get stuck. Let's jump right in!

Guides    Changelog

TeamCity integration

In order to integrate your tests with TeamCity, first you need to have node.js (version >= 10.0.0) installed on the TeamCity machine or one of its slave machines.

Now, just follow these steps:

  1. Create a New Build Step in your project:
  1. Choose "Command Line" runner type:
  1. Set the Custom Script with the appropriate parameters, as described in the CLI page.
    Here is the basic script template, containing the first part that makes sure you have the latest npm package, and the CLI command itself:
set -x
mkdir -p "%system.teamcity.build.workingDir%/.npm-packages"
export NODE_PATH="$NODE_PATH:$NPM_PACKAGES/lib/node_modules"
npm config set prefix %system.teamcity.build.workingDir%/.npm-packages
npm install -g @testim/testim-cli
set +x
%system.teamcity.build.workingDir%/.npm-packages/bin/testim \
 --label "<YOUR LABEL>" \
 --token "<YOUR ACCESS TOKEN>" \
 --project "<YOUR PROJECT ID>" \
 --grid "<Your grid name>" \
 --reporters teamcity,console

In order for TeamCity to store, analyze and show the results, Testim generates a unique TeamCity report format which is automatically recognized:


  1. You can see its progress test-by-test as they are executed!
  2. For the grid name, read here how to set up your grid.
  3. When using the arguments --reporters teamcity, console --retries combined, even if a test passed on a retry, teamcity will record both the failed and passed executions and the build will be marked as failure even though the suite might pass.

Updated about a year ago

TeamCity integration

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.