Skip to main content


Pre requisite

In order to run you will to have :

  • NodeJs installed
  • Npm or Yarn installed

Install with npm

To install RestQA globally, run the command:

npm install @restqa/restqa -g

Then you can chek your install:

restqa --version

Give RestQA a spin without install

Using NPX

To spin up RestQA without installing it, you can run:

npx @restqa/restqa --version


To play around with RestQA, you can also start it using Docker:

docker run -it --rm \
  --name restqa \
  -v $PWD:/app \
  restqa/restqa --version

As you can see you will need to mount your current folder into the container location /app.