A command line interface to the Box Content API.
To get started with the Box CLI, first 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. 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"
$ 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: firstname.lastname@example.org 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'
box autocomplete- Display autocomplete installation instructions
box collaboration-whitelist- List collaboration whitelist 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 files- Manage files
box folders- Manage folders
box groups- List all groups
box help- Display help for the Box CLI
box legal-hold-policies- List legal hold policies
box metadata-cascade-policies- List the metadata cascade policies on a folder
box metadata-templates- Get all metadata templates in your Enterprise
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 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?
Contributing to the Box CLI
- Clone this repo.
npm testto ensure everything is working.
- Make the changes you want in the
src/directory. Be sure to add corresponding tests in the
- 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
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.