Box CLI

CLI discovered

Details

Command: box
Docs: https://box.dev/guides/cli

Authentication

Box access token bearer discovered Get token ↗

CLI login

Create a Box app in the Developer Console or generate a short-lived developer token there. Box docs state every API endpoint requires a valid access token, sent as Authorization: Bearer .... Easiest path for testing: open your app’s Configuration tab and click Generate Developer Token as shown in the Developer Tokens guide. For production, configure OAuth 2.0, JWT, or Client Credentials on your app from the same console per the authentication overview.

Box OAuth 2.0 app credentials oauth2 discovered $ box login --platform-app

Acquired by the CLI — running box login --platform-app opens the auth flow and stores the credential.

Box JWT app configuration app discovered $ box configure:environments:add PATH_TO_CONFIG_FILE

Acquired by the CLI — running box configure:environments:add PATH_TO_CONFIG_FILE opens the auth flow and stores the credential.

Box Client Credentials Grant app credentials oauth2_cc discovered $ box configure:environments:add PATH_TO_CONFIG_FILE_OR_SETTINGS

Acquired by the CLI — running box configure:environments:add PATH_TO_CONFIG_FILE_OR_SETTINGS opens the auth flow and stores the credential.