CLI - BugBug Documentation

Integrate with CI/CD using BugBug Command Line Interface
You can operate BugBug via the Command Line Interface (CLI). This empowers you to integrate with any continuous integration (CI) or continous deployment (CD) pipelines 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:
npm install -g @testrevolution/bugbug-cli
Remember that you need to have admin user permissions on nodeJS execution.
Get your API token
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:
bugbug config set-token API_TOKEN_FROM_WEBAPP_PROJECT_SETTINGS
Run tests from terminal
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:
bugbug remote run test TEST_Id
Find your suite ID
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!
Run tests from your build pipeline
Update your CI/CD build scripts to see test results directly in your build management tool (for example in Bitbucket)
Here's an example what you can add to your build script. 
You can also override individual variables from the command line with --variable variableName="customVariableValue". This allows you to run different combinations of test data in different environments, for example, you can insert a different user password on prod and different on staging. 
If you're ambitious 
Command line variables override allows you to test various combinations of test data. You could create a for each type of script and execute a suite with all the combinations. 
​
When you run your pipeline, BugBug tests would be triggered and your build will only be successful if all tests passed.
Also read: our advanced guide to automation testing for startups​
​
​
 
​
​

Collaboration - Previous

Inviting team members

Next - Integrations

Zapier

Last modified 6d ago

Copy link

Outline

Integrate with CI/CD using BugBug Command Line Interface

Install via NPM

Get your API token

Run tests from terminal

Find your suite ID

Run tests from your build pipeline