CLI

Integrate with anything using BugBug Command Line Interface

You can operate BugBug via the Command Line Interface (CLI). This empowers you to integrate with any pipeline or build system hooks.

Install via NPM

Open your terminal. First of all you need to nodeJS installed in your machine. Then go for npm installation.
npm: @testrevolution/bugbug-cli
npm
After you have nodeJS and npm installed simply run:
1
npm install -g @testrevolution/bugbug-cli
Copied!
Remember that you need to have admin user permissions on nodeJS execution.

Connect with a project

You need to take the API token of the project you want to run with CLI. You will find that in BugBug web app in Project settings in General tab:
Then configure CLI with alphanumerical project's API token:
1
bugbug config set-token API_TOKEN_FROM_WEBAPP_PROJECT_SETTINGS
Copied!

Treat yourself with CLI

In BugBug npm's page you find the available commands. You can also just strike bugbug help to see what you can do and how.
Example: list suites within the connected project:
To run a particular test via CLI you need to find the ID of the test. It's easy, just go to your test, expand 3 dots and select Run via CLI. Just simply copy the commad for running, open terminal and paste and run. The commad looks as below:
1
bugbug remote run test TEST_Id
Copied!
You can run whole suite as well by going to Suites tab, expanding the details and selecting Run via CLI. The command is the same but SUITE_ID is different. That's how we recognize you want to run the whole suite!