@box/cli

Box CLI

The Box CLI is a user-friendly command line tool which allows both technical and non-technical users to leverage the Box API to perform routine or bulk actions. There is no need to write any code, as these actions are executed through a set of commands.

Among other features, Box CLI includes the following functionality:

• Bulk actions - A csv file can be used to execute commands in bulk, and each row of the spreadsheet is treated as an individual API call.
• As-User header - Act on behalf of another user.
• Search API - Search for files and folders in your Box Enterprise account.

Table of contents

• Getting Started
  • CLI Installation
  • CLI and Server Authentication with JWT
• Usage
• Command Topics
• Questions, Bugs, and Feature Requests?
• Versions
  • Supported Version
  • Version schedule
• Contributing to the Box CLI
• Copyright and License

Getting Started

The most convenient way to get start with Box CLI is to follow Box CLI with OAuth 2.0 guide. You will be guided how to configure Box application and install CLI on your machine.

CLI Installation

Installers are available for Windows and macOS. However, the raw source-code is available if you would like to build the CLI in other environments.

Windows & macOS Installers

To install the latest CLI on your machine, download the latest .exe for Windows or .pkg for macOS for the latest release.

Linux & Node install

Additionally, the CLI can be installed as a Node package on any platform, including Linux. For this to work, you will need to have Node JS installed on your machine.

npm install --global @box/cli

CLI and Server Authentication with JWT

Alternatively, to get started with the Box CLI, download and install CLI, set up a Box application using Server Authentication with JWT and download the JSON configuration file from the Configuration page of your app in the Box Developer Console following JWT CLI Guide. Then, set up the CLI by pointing it to your configuration file:

$ box configure:environments:add PATH_TO_CONFIG_FILE
Successfully added CLI environment "default"

If you manually generated your own private key to use with JWT authentication, you will need to point the CLI to the location of your private key file:

$ box configure:environments:add PATH_TO_CONFIG_FILE --private-key-path PATH_TO_PRIVATE_KEY --name ManualKey
Successfully added CLI environment "ManualKey"

Usage

$ box --version
box-cli/0.0.0 darwin-x64 node-v10.10.0
$ box users:get --help
Get information about a Box user

USAGE
  $ box users:get [ID]

ARGUMENTS
  ID  [default: me] ID of the user to get; defaults to the current user

OPTIONS
  -h, --help                             Show CLI help
  -s, --save                             Save report to default reports folder on disk
  -t, --token=token                      Provide a token to perform this call
  -v, --verbose                          Show verbose output, which can be helpful for debugging
  -y, --yes                              Automatically respond yes to all confirmation prompts
  --as-user=as-user                      Provide an ID for a user
  --bulk-file-path=bulk-file-path        File path to bulk .csv or .json objects
  --csv                                  Output formatted CSV
  --fields=fields                        Comma separated list of fields to show
  --json                                 Output formatted JSON
  --no-color                             Turn off colors for logging
  --save-to-file-path=save-to-file-path  Override default file path to save report
$ box users:get
Type: user
ID: '77777'
Name: Example User
Login: [e-mail]
Created At: '2016-12-07T17:30:40-08:00'
Modified At: '2018-11-15T17:33:06-08:00'
Language: en
Timezone: America/Los_Angeles
Space Amount: 10737418240
Space Used: 53569393
Max Upload Size: 5368709120
Status: active
Job Title: ''
Phone: ''
Address: ''
Avatar URL: 'https://app.box.com/api/avatar/large/77777'

Command Topics

• box ai - Sends an AI request to supported LLMs and returns an answer
• box autocomplete - Display autocomplete installation instructions
• box collaboration-allowlist - List collaboration allowlist entries
• box collaborations - Manage collaborations
• box collections - List your collections
• box comments - Manage comments on files
• box configure - Configure the Box CLI
• box device-pins - List all the device pins for your enterprise
• box events - Get events
• box file-requests - Copies existing file request to new folder
• box files - Manage files
• box folders - Manage folders
• box groups - List all groups
• box help - Display help for the Box CLI
• box integration-mappings - List Slack integration mappings
• box legal-hold-policies - List legal hold policies
• box login - Sign in with OAuth and set a new environment or update an existing if reauthorize flag is used
• box metadata-cascade-policies - List the metadata cascade policies on a folder
• box metadata-query - Create a search using SQL-like syntax to return items that match specific metadata
• box metadata-templates - Get all metadata templates in your Enterprise
• box oss - Print a list of open-source licensed packages used in the Box CLI
• box recent-items - List information about files accessed in the past 90 days up to a 1000 items
• box request - Manually specify a Box API request
• box retention-policies - List all retention policies for your enterprise
• box search - Search for files and folders in your Enterprise
• box shared-links - Manage shared links
• box sign-requests - List sign requests
• box sign-templates - List sign templates
• box storage-policies - List storage policies
• box tasks - Manage tasks
• box terms-of-service - List terms of services for your enterprise
• box tokens - Get a token. Returns the service account token by default
• box trash - List all items in trash
• box users - List all Box users
• box watermarking - Apply a watermark on an item
• box web-links - Manage web links
• box webhooks - List all webhooks

Questions, Bugs, and Feature Requests?

Browse the issues tickets! Or, if that doesn't work, file a new one and someone will get back to you. If you have general questions about the Box API, you can post to the Box Developer Forum.

Versions

We use a modified version of Semantic Versioning for all changes. See version strategy for details which is effective from 30 July 2022.

Supported Version

Only the current MAJOR version of SDK is supported. New features, functionality, bug fixes, and security updates will only be added to the current MAJOR version.

A current release is on the leading edge of our SDK development, and is intended for customers who are in active development and want the latest and greatest features. Instead of stating a release date for a new feature, we set a fixed minor or patch release cadence of maximum 2-3 months (while we may release more often). At the same time, there is no schedule for major or breaking release. Instead, we will communicate one quarter in advance the upcoming breaking change to allow customers to plan for the upgrade. We always recommend that all users run the latest available minor release for whatever major version is in use. We highly recommend upgrading to the latest SDK major release at the earliest convenient time and before the EOL date.

Version schedule

Version	Supported Environments	State	First Release	EOL/Terminated
3	Node.js >= 14	Supported	01 Feb 2022	TBD
2		EOL	14 Dec 2018	01 Feb 2022
1		EOL	01 Nov 2017	14 Dec 2018

Contributing to the Box CLI

1. Clone this repo.
2. Run npm install.
3. Run npm test to ensure everything is working.
4. Make the changes you want in the src/ directory. Be sure to add corresponding tests in the test/ directory!
5. Create a pull request with your changes — we'll review it and help you get it merged.

For more information, please see the Contribution guidelines.

Copyright and License

Copyright 2018 Box, Inc. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

This software includes third party libraries, which are distributed under their own licenses' terms; see LICENSE-THIRD-PARTY.txt for details.

Changelog

3.16.0 (2024-11-25)

New Features and Enhancements

• add support for template_id during sign request creation (#549) (95963c1)

Bug Fixes

• Change zone name in the mass update user zone script (#546) (1a1d603)