Skip to main content

Installing the Openlane CLI

The Openlane CLI authenticates for local development either with an API or personal access token or with username and password credentials.

Installation​

MacOS​

The Openlane CLI is available for MacOS using homebrew.

brew install --cask theopenlane/tap/openlane

From Source​

Download the CLI directly from GitHub releases.

Authentication​

info

OAuth login is not currently supported using the CLI. You must use an API or Personal Access Token instead.

Using API or Personal Access Tokens​

export CORE_TOKEN=tola_REDACTED
export CORE_PAT=tolp_REDACTED

Using username and password credentials​

  1. Run the login command

    openlane login -u [email protected]

  2. You should see a prompt to enter your password

  3. You should see a prompt to store your access token, refresh token, and session token in your local keychain

tip

We recommend setting the Openlane CLI to always allow in your Keychain so you do not need to continuously approve the storage and retrieval on every command.