`box auth`

Activate a license and prepare the capabilities included in your Box plan.

box auth --key <license-key> [--org <name>]

Synopsis

box auth is the command that turns a freshly scaffolded box into an authorized, runnable one. It securely validates your Potter license, prepares the approved software for your Box, and enables the capabilities included in your plan.

Options

Option	Required	Description
`--key <license-key>`	yes	Your Potter license key.
`--org <name>`	no	Organization name to associate with the activation.

Behavior

Activate the license

Securely confirms that the license is active and associates the Box with your organization.

Prepare approved software

Authorizes the Box to obtain the Potter software included in its plan.

Protect local credentials

Records non-secret subscription information in the Box configuration.
Stores private activation credentials in a protected, git-ignored local file.

Enable plan capabilities

Enables the commerce services included in the plan.
Makes the relevant areas available in the Box console and merchant dashboards.

When finished, the CLI prints a summary of the activated tier and the capabilities your box now has.

⚠️

Activation credentials are private. The generated Box keeps them in protected, git-ignored local files. Never copy those files into source control, tickets, screenshots, or chat messages.

Examples

# Activate with an organization name
box auth --org acme-bank --key pk_live_xxxxxxxx
 
# Minimal activation
box auth --key pk_live_xxxxxxxx

Deprecated alias: `box activate`

box activate <license-key>   # deprecated: use `box auth` instead

box activate is a hidden, deprecated alias for box auth. It prints a deprecation warning and forwards to the same flow. Prefer box auth.

box auth