SupportAPI docsProduct updatesSign up for free
Search…
Snyk User Documentation
Introducing Snyk
Implementing Snyk in your teams
Getting started
Snyk Web UI
Snyk CLI
Getting started with the CLI
Scan and maintain projects using the CLI
CLI commands and options summary
CLI help
Install or update the Snyk CLI
Authenticate the CLI with your account
Configure the Snyk CLI
Snyk API
Snyk for IDEs
Snyk Apps
Snyk Integrations
SNYK PRODUCTS
Snyk Open Source
Snyk Code
Snyk Container
Snyk Infrastructure as Code
USING SNYK
Snyk Broker
User and group management
Fixing and prioritizing issues
Reports
Snyk Tools
SNYK INFO
Disclosing vulnerabilities
How Snyk handles your data
Snyk Partner workshops
Powered By GitBook
Authenticate the CLI with your account
To associate the Snyk CLI for use with your Snyk account, you must first authenticate your machine. No repository permissions are needed at this stage, only your email address. When you have authenticated, you can get started using the CLI.
You can authenticate:
  • Through your browser by running snyk auth from the CLI; see the Auth command help.
  • Using your API token
  • Using the SNYK_TOKEN environment variable; see Configure the Snyk CLI. Use SNYK_TOKEN in a CI/CD environment.
To authenticate using your API token:
  1. 1.
    Go to your Snyk account (Account Settings > API Token section).
  2. 2.
    In the KEY field, click click to show; then select and copy your API token. A screenshot follows.
  3. 3.
    In the CLI, run snyk auth [<API_TOKEN>] or snyk config set api=<token>. The <API_TOKEN>is validated by the Snyk API.
Snyk Account Settings, API Token
Previous
Install or update the Snyk CLI
Next
Configure the Snyk CLI
Last modified 8d ago
Export as PDF
Copy link
Edit on GitHub