Skip to main content


Start a new restqa project

As mentioned from the getting started page, in order to run your test automation using RestQA you will need to have a .restqa.yml file in your folder.

Otherwise RestQA client provides a command to pre-configure it for your project.

restqa init

You can also initialize your project without answering the question by using the command :

restqa init -y

Install a new integration

Retrieve the list of available integration:

restqa install 

If you want to install Slack integration:

restqa install slack


restqa install <INTEGRATION>

Step definition

To get the list of different steps available for your scenario:


restqa steps given


restqa steps when


restqa steps then


cli steps example

There are options available:

--tag-tFilter the step to a specific keyword
--config-cSpecify the configuration file to use.restqa.yml

Run the test

You can run the test by using the command:

restqa run


restqa r

A few options are available:

--config-cSpecify the configuration file to use.restqa.yml
--env-eSpecify the environement to pick from the configuration fileDefault environment in the config
--tag-tSpecify the tag to pre-select features or scenarios

Example project

RestQA provides a simple example that you can run using the command:

restqa example


restqa ex

Generate Scenario (curl)

If your API is already developed and you want a test scenario to check the non-regression, the best is just to generate a scenario from your curl command.


restqa generate curl

Output (console):

Given I have the api gateway hosted on ""
  And I have the path "/todos/1"
  And I have the method "GET"
When I run the API
Then I should receive a response with the status 200
  And the response body should be equal to:
  "userId": 1,
  "id": 1,
  "title": "delectus aut autem",
  "completed": false

If you want to export the content into a file, you need to use the -o option.

To export the generated scenario into the file Generated Scenario into the generated.feature

restqa generate  curl -o generated.feature


If your interested by a user interface to integrate your test. Your wish has been granted!


restqa dashboard

There are options available:

--config-cSpecify the configuration file to use.restqa.yml
--port-pSpecify the running http port8081
--read-only-rRestrict the access to the feature file as read only


The telemetry options can be enabled or disabled as you wishes.

Enable the telemetry:

restqa telemetry on

Disable the telemetry:

restqa telemetry off

Environement variable

In order to override some options, you can use the environment variables below:

  • RESTQA_TELEMETRY: enable or disable the telemetry (value: on | off)
  • RESTQA_CONFIG: Define the location of the .restqa.yml configuration file
  • RESTQA_ENV: Define the environement to select withing the .restqa.yml
  • RESTQA_DASHBOARD_READONLY: Restrict the access to the feature file while running the dashboard (value: true)