Setup | Superadmin
Superadmin

Documentation

Setup

How to setup the command line client.

The recommended setup is to install the cli as a devDependency and use a script in your package.json to assign a npm run superadmin command.

This has a couple of advantages but you can invoke the cli by installing it globally as well, that is supported.

Let's look at an example package.json with the following setup.

{
  "scripts": {
    "test": "superadmin-cli --projects Engineering"
  },
  "devDependencies": {
    "superadmin-cli": "latest"
  }
}

This instructs the test runner to run the project Engineering upon startup. Now in the CI all we need to do is run the command npm run test and the test runner will run tests in the project. Note: Authentication is still required in your CI.

Running binary

The superadmin-cli acts like a binary that invokes node. It may be advisable to run the binary directly because npm run does not forward exit codes. If the exit codes are not returned, typically your CI will continue without stopping even though superadmin-cli threw an error.

In this case, you would want to run either of the following:

$ node_modules/.bin/superadmin-cli --projects Engineering

Or globally:

$ npm i -g superadmin-cli
$ superadmin-cli --projects Engineering

Learn more about the usage of the test-runner in Usage