CLI

Configure & run

After installing the CLI, add your API key and run a scan. Keys can live in a config file or environment variables.

Configure & run

  1. Create an API key in the app: Settings → API keys. Keys start with ba_ and the full secret is shown only once at creation.
  2. Provide the key to the CLI—persist it in config or set SLATE_API_KEY for the current shell (and CI):
    slate config set-key ba_your_key_here
    export SLATE_API_KEY=ba_your_key_here
  3. Run a scan:
    slate example.com --wait

More commands: Usage.

Config file

Settings are stored at ~/.config/slate/config.yaml. Use slate config subcommands to view or update values.

Environment variables

Environment variables override the config file. Use a custom API URL only for local development or staging—production should use https://api.slatesecurity.ai.

export SLATE_API_KEY=ba_your_key_here
export SLATE_API_URL=https://api.slatesecurity.ai