Get started

Fast guide to jump into Autokin development

The best way to get started is to run examples and play around with it. Simply, in few minutes you have your working automated test.

Before we start, Get Node!

Autokin works with NodeJS, and it must be installed first before anything. You can work with the latest or atleast v12. To install you can download from here and choose the correct package for your machine:

If you want to maintain cleanliness or organization of your Node versions, please use this version manager for Node:

You can follow installation instructions that can be found on both links. Once you have Node in your system, you can now proceed to the next steps. Enjoy!

Create an Autokin Project

To kickstart, let's start by creating a project folder.

mkdir my-autokin-project

Name the folder anything that you see fit. Before proceeding to next step make sure that you are inside the new folder.

cd my-autokin-project


Next, let's install autokin.

npm install autokin

It is assumed that you have your NodeJS environment setup. If you need more guidance on this, please see

Generate boilerplate project

Autokin comes with a very very simple boilerplate project, which comes with a single scenario where you can build your own on top of it. To generate the project, use the following command:

./node_modules/.bin/autokin --init

This will create the necessary folder structure and sample files.

      ├── features
      |    ├── support
      |         ├── steps.js
      └── first.feature

Let's run the test!

Running your first Autokin test

Now, you are ready to go. Run our Autokin test, just follow this command:

./node_modules/.bin/autokin --exec

This will pickup all the Gherkin test with .feature extension file under the features folder. It should have the following output:

./node_modules/.bin/autokin -e
Autokin Test Run
Feature: My Feature > My First Scenario - ✔ Passed

Test Result Summary
│ Features   │ Result │ Scenarios │ Steps │
│ My Feature │    --- │         1 │     0 │

│ Features / Scenarios   │ Result │ Steps │ Passed │ Failed │ Skipped │ Pending │ Ambiguous │ Unknown │
│ My Feature                                                                                          │
│      My First Scenario │ ---    │     0 │      0 │      0 │       0 │       0 │         0 │       0 │

Runtime Options

Last updated