guardrails

GuardRails CLI

• guardrails
• Usage
• Commands

Usage

$ npm install -g guardrails
$ guardrails COMMAND

Commands

• guardrails config
• guardrails help [COMMAND]
• guardrails last
• guardrails scan

guardrails config

set cli configuration

USAGE
  $ guardrails config

OPTIONS
  -t, --token=token  (required) set your CLI token

EXAMPLES
  $ guardrails config --token <your-cli-token>
  $ guardrails config --help

guardrails help [COMMAND]

display help for guardrails

USAGE
  $ guardrails help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

guardrails last

view last report

USAGE
  $ guardrails last

OPTIONS
  -j, --json  print only report as json
  -o, --open  open dashboard url in browser
  -u, --url   display dashboard URL of the report

EXAMPLES
  $ guardrails last
  $ guardrails scan --url
  $ guardrails scan --json
  $ guardrails scan --help

guardrails scan

trigger scan

USAGE
  $ guardrails scan

OPTIONS
  -a, --api=api                   [default: https://api.guardrails.io] Guardrails API's URL
  -d, --dir=dir                   [default: .] specify a directory to scan
  -j, --json                      print only report as json
  -n, --failOnNewVulnerabilities  fail depending on new vulnerabilities count instead of total vulnerabilities
  -o, --open                      open dashboard URL in browser
  -r, --rejectUnauthorized        disable rejecting unauthorized SSL
  -t, --timeout=timeout           [default: 21] set fetching report timeout in munutes
  -u, --url                       return dashboard URL instead of fetching report
  -z, --zip                       use zipped codebase as source for the scan

EXAMPLES
  $ guardrails scan
  $ guardrails scan --zip
  $ guardrails scan --help