The Box CLI is a command-line interface for interacting with the Box API, designed for both technical and non-technical users to perform routine or bulk actions on Box content without writing code. It offers features like bulk operations via CSV, acting as other users, and searching within a Box enterprise account.

How It Works

The CLI is built on the oclif framework, providing a structured way to define commands and arguments. It supports authentication via OAuth 2.0 or JWT Server Authentication, allowing secure access to Box resources. The tool translates user commands into API calls, abstracting the complexity of direct API interaction.

Quick Start & Requirements

• Install globally via npm: npm install --global @box/cli
• Requires Node.js. Version 4.0.0 supports Node 20 and 22.
• Official documentation and guides are available for setup and usage.

Highlighted Details

• Supports bulk actions using CSV files for batch API operations.
• Enables acting as other users via the --as-user flag.
• Includes a box search command for finding files and folders.
• Offers a box ai command for interacting with LLMs.

Maintenance & Community

The project is actively maintained by Box, Inc. with a clear versioning strategy and support schedule. Contributions are welcome via pull requests.

Licensing & Compatibility

Licensed under the Apache License, Version 2.0. This license is permissive and generally compatible with commercial and closed-source applications.

Limitations & Caveats

Version 4.0.0 requires Node.js 20 or 22, dropping support for older Node versions (14, 16). Only the current major version of the CLI is supported with new features and bug fixes.