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

What is the Testim Dev Kit?

The Testim Dev Kit is a flexible and accessible end-to-end testing automation framework.

The Dev Kit enables programmers to create or edit tests in code. There are several advantages to creating or editing your test in code. First, you can store and manage your tests as code next to your application code. When you make a change to your application that might affect your test, you can quickly edit the test, keeping them in sync. Second, some people just think and work better when they can see the logical structure of a test as written in code. Finally, there are some things that you can do with your IDE such as search, refactoring, code complete, that are difficult to do in a visual editor.

Even if you want to write tests in code, we recommend that you start by recording a test with the Testim Chrome Extension so that you leverage Testim's AI-based Smart Locators. You can then export it to code where you can edit it in your IDE. This way, you get the benefits of fast authoring and AI-based stability with the flexibility to edit and store as code.

TL;DR

The Dev Kit includes:

  • Modern JavaScript API for creating and editing functional end-to-end tests in code
  • Example tests to help you get started
  • Robust root cause analysis tools to help you troubleshoot
  • Export recorded tests to code to jumpstart your coding and to leverage Smart Locators for maximum stability. They also help eliminate vendor lock-in.

The Dev Kit gives you access to a powerful JavaScript API that enables you to create, customize, debug and run coded tests to verify the end-to-end functionality of your web-based application.

Testim also includes an advanced recorder that uses AI to identify hundreds of attributes for each visual element, weigh them and assign a Smart Locator that helps keep your tests stable even when code changes. Recorded tests can be exported to code where they can be edited in your IDE. You can store them next to your application code in your Version Control System (e.g. GitHub) and keep them in sync with branches, commits, PRs and releases.

The Dev Kit offers similar functionality to tools like Selenium, Puppeteer and Cypress with some key differences aimed at improving authoring speed, stability, user experience, and debuggability.

Help! I am a busy developer!

Install testim with NPM:

npm install -g @testim/testim-cli

Initialize a new project:

testim init 'my-awesome-project'

Link the project to your Testim account:

testim --login

The credentials can be found under the ⚙️settings page in your Testim account

Edit your tests:

code .

Run tests directly in VSCode or WebStorm with the built-in support or use:

npm start

Tests are automatically debuggable and are written in plain JavaScript.

See the API Reference on how to use our API commands and our Getting Started guide including some examples on how to write a test.

The output of the code will also include a URL containing live results which you can use to gain more insight into your tests.

Updated about a month ago


What is the Testim Dev Kit?


The Testim Dev Kit is a flexible and accessible end-to-end testing automation framework.

Suggested Edits are limited on API Reference Pages

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