Skip to content
Periphery

Authentication

Periphery supports three authentication mechanisms. Choose the one that matches where the scan runs.

Browser authentication

Section titled “Browser authentication”

For interactive scans, create a Periphery account and sign in from the CLI:

Terminal window
periphery auth login

Authentication is completed in your browser. Use periphery auth status to check whether you’re signed in, and periphery auth logout to end the session.

Access token

Section titled “Access token”

For non-interactive scans, create an access token in the account area and provide it through PERIPHERY_TOKEN:

Terminal window
export PERIPHERY_TOKEN="${PERIPHERY_CI_SECRET}"
periphery scan

This mechanism is best suited to CI environments. Treat the access token as a secret and expose it only to trusted jobs. See Continuous Integration for an example.

Public open-source workflow

Section titled “Public open-source workflow”

Public GitHub repositories can use the official reusable workflow, which authenticates the scan without a Periphery account or credential. See Open-source Projects for setup instructions.