login

Introduction

Note

Before proceeding with the command, generate a personal API key.

Use the login command to authenticate to the API registry.

When you log in, the preview-docs command will start a preview server using Redocly API reference docs with all of the premium features.

Also, you will be able to access your members-only (private) API definitions in the Redocly registry, and use the push command.

If you're having issues with the login command, use the --verbose option to display a detailed error trace (if any).

Usage

Copy
Copied
redocly login [--help] [--verbose] [--version]

redocly login --verbose

Options

Option Type Description
--help boolean Show help.
--verbose boolean Include additional output.
--version boolean Show version number.
--region, -r string Specify which region to use when logging in. Supported values: us, eu. Read more about configuring the region.

Examples

Successful loginFailed login
Copy
Copied
redocly login
  🔑 Copy your API key from https://app.redocly.com/profile and paste it below:

  Logging in...
  Authorization confirmed. ✅
Copy
Copied
redocly login
  🔑 Copy your API key from https://app.redocly.com/profile and paste it below:

  Logging in...
  Authorization failed. Please check if you entered a valid API key.