@box/cli
Official command line interface for the Box API
Last updated a month ago by mattwiller .
Apache-2.0 · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @box/cli 
SYNC missed versions from official npm registry.

Box CLI

Project Status

A command line interface to the Box Content API.

Getting Started

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"

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: user@example.com
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 autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ box autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

OPTIONS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

EXAMPLES
  $ box autocomplete
  $ box autocomplete bash
  $ box autocomplete zsh
  $ box autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

box collaboration-whitelist

List collaboration whitelist entries

USAGE
  $ box collaboration-whitelist

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

See code: src/commands/collaboration-whitelist/index.js

box collaboration-whitelist:add DOMAIN

Add a collaboration whitelist entry

USAGE
  $ box collaboration-whitelist:add DOMAIN

ARGUMENTS
  DOMAIN  Domain to add to whitelist (e.g. box.com)

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
  --direction=inbound|outbound|both      (required) Direction to whitelist collaboration in
  --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

See code: src/commands/collaboration-whitelist/add.js

box collaboration-whitelist:delete ID

Delete a collaboration whitelist entry

USAGE
  $ box collaboration-whitelist:delete ID

ARGUMENTS
  ID  ID of the collaboration whitelist entry record to delete

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

See code: src/commands/collaboration-whitelist/delete.js

box collaboration-whitelist:exemptions

List collaboration whitelist exemptions

USAGE
  $ box collaboration-whitelist:exemptions

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

See code: src/commands/collaboration-whitelist/exemptions/index.js

box collaboration-whitelist:exemptions:create USERID

Exempt a user from the collaboration whitelist

USAGE
  $ box collaboration-whitelist:exemptions:create USERID

ARGUMENTS
  USERID  ID of the user to exempt from the collaboration whitelist

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

See code: src/commands/collaboration-whitelist/exemptions/create.js

box collaboration-whitelist:exemptions:delete ID

Delete a collaboration whitelist exemption

USAGE
  $ box collaboration-whitelist:exemptions:delete ID

ARGUMENTS
  ID  ID of the whitelist exemption record to delete

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

See code: src/commands/collaboration-whitelist/exemptions/delete.js

box collaboration-whitelist:exemptions:get ID

Get a collaboration whitelist exemption

USAGE
  $ box collaboration-whitelist:exemptions:get ID

ARGUMENTS
  ID  ID of the whitelist exemption record to get

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

See code: src/commands/collaboration-whitelist/exemptions/get.js

box collaboration-whitelist:get ID

Get a collaboration whitelist entry

USAGE
  $ box collaboration-whitelist:get ID

ARGUMENTS
  ID  ID of the collaboration whitelist entry record to get

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

See code: src/commands/collaboration-whitelist/get.js

box collaborations:delete ID

Remove a collaboration

USAGE
  $ box collaborations:delete ID

ARGUMENTS
  ID  The ID of the collaboration to delete

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

ALIASES
  $ box files:collaborations:delete
  $ box folders:collaborations:delete

See code: src/commands/collaborations/delete.js

box collaborations:get ID

Get an individual collaboration

USAGE
  $ box collaborations:get ID

ARGUMENTS
  ID  ID of the collaboration to get

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

See code: src/commands/collaborations/get.js

box collaborations:pending

List all pending collaborations for a user

USAGE
  $ box collaborations:pending

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

ALIASES
  $ box collaborations:get-pending

See code: src/commands/collaborations/pending.js

box collaborations:update ID

Update a collaboration

USAGE
  $ box collaborations:update ID

ARGUMENTS
  ID  The ID of the collaboration to update

OPTIONS
  -h, --help                                                                                     Show CLI help

  -r, --role=editor|viewer|previewer|uploader|previewer_uploader|viewer_uploader|co-owner|owner  An option to manually
                                                                                                 enter the role

  -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

  --[no-]can-view-path                                                                           Whether view path
                                                                                                 collaboration feature
                                                                                                 is enabled or not

  --csv                                                                                          Output formatted CSV

  --expires-at=expires-at                                                                        When the collaboration
                                                                                                 should expire

  --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

  --status=accepted|pending|rejected                                                             Update the
                                                                                                 collaboration status

ALIASES
  $ box files:collaborations:update
  $ box folders:collaborations:update

See code: src/commands/collaborations/update.js

box collections

List your collections

USAGE
  $ box collections

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

ALIASES
  $ box collections:list

See code: src/commands/collections/index.js

box collections:add ITEMTYPE ITEMID COLLECTIONID

Add an item to a collection

USAGE
  $ box collections:add ITEMTYPE ITEMID COLLECTIONID

ARGUMENTS
  ITEMTYPE      (folder|file|web_link) Type of item
  ITEMID        ID of the of item
  COLLECTIONID  ID of collection

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

See code: src/commands/collections/add.js

box collections:items ID

Get items in a collection

USAGE
  $ box collections:items ID

ARGUMENTS
  ID  ID of the collection to retrieve the items of

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

See code: src/commands/collections/items.js

box collections:remove ITEMTYPE ITEMID COLLECTIONID

Remove an item from a collection

USAGE
  $ box collections:remove ITEMTYPE ITEMID COLLECTIONID

ARGUMENTS
  ITEMTYPE      (folder|file) Type of item
  ITEMID        ID of item
  COLLECTIONID  ID of collection

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

See code: src/commands/collections/remove.js

box comments:create FILEID

Create a comment on a file

USAGE
  $ box comments:create FILEID

ARGUMENTS
  FILEID  ID of file on which to comment

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
  --message=message                      Message of comment
  --no-color                             Turn off colors for logging
  --save-to-file-path=save-to-file-path  Override default file path to save report

  --tagged-message=tagged-message        The text of the comment, including @[userid:Username] somewhere in the message
                                         to mention the user

See code: src/commands/comments/create.js

box comments:delete ID

Delete a comment

USAGE
  $ box comments:delete ID

ARGUMENTS
  ID  ID of the comment to delete

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

See code: src/commands/comments/delete.js

box comments:get ID

Get information about a comment

USAGE
  $ box comments:get ID

ARGUMENTS
  ID  ID of the comment to get

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

See code: src/commands/comments/get.js

box comments:reply ID

Reply to a comment

USAGE
  $ box comments:reply ID

ARGUMENTS
  ID  ID of the comment to reply to

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
  --message=message                      Message of comment
  --no-color                             Turn off colors for logging
  --save-to-file-path=save-to-file-path  Override default file path to save report

  --tagged-message=tagged-message        The text of the comment, including @[userid:Username] somewhere in the message
                                         to mention the user

See code: src/commands/comments/reply.js

box comments:update ID

Update a comment

USAGE
  $ box comments:update ID

ARGUMENTS
  ID  ID of the comment to update

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
  --message=message                      The text of the comment
  --no-color                             Turn off colors for logging
  --save-to-file-path=save-to-file-path  Override default file path to save report
  --tagged-message=tagged-message        The tagged text of the comment

See code: src/commands/comments/update.js

box configure:environments:add PATH

Add a new Box environment

USAGE
  $ box configure:environments:add PATH

ARGUMENTS
  PATH  Provide a file path to configuration file

OPTIONS
  -h, --help                           Show CLI help
  -n, --name=name                      [default: default] Set a name for the environment
  -v, --verbose                        Show verbose output, which can be helpful for debugging
  --no-color                           Turn off colors for logging
  --private-key-path=private-key-path  Provide a path to application private key
  --set-as-current                     Set this new environment as your current environment

See code: src/commands/configure/environments/add.js

box configure:environments:delete [NAME]

Delete a Box environment

USAGE
  $ box configure:environments:delete [NAME]

ARGUMENTS
  NAME  Name of the environment

OPTIONS
  -h, --help     Show CLI help
  -v, --verbose  Show verbose output, which can be helpful for debugging
  --no-color     Turn off colors for logging

See code: src/commands/configure/environments/delete.js

box configure:environments:get

Get a Box environment

USAGE
  $ box configure:environments:get

OPTIONS
  -c, --current    Get the current default Box environment
  -h, --help       Show CLI help
  -n, --name=name  Get a Box environment with this name
  -v, --verbose    Show verbose output, which can be helpful for debugging
  --no-color       Turn off colors for logging

See code: src/commands/configure/environments/get.js

box configure:environments:set-current [NAME]

Set your current Box environment to use

USAGE
  $ box configure:environments:set-current [NAME]

ARGUMENTS
  NAME  Name of the environment

OPTIONS
  -h, --help     Show CLI help
  -v, --verbose  Show verbose output, which can be helpful for debugging
  --no-color     Turn off colors for logging

ALIASES
  $ box configure:environments:select

See code: src/commands/configure/environments/set-current.js

box configure:environments:switch-user [USERID]

Switch the default Box user to run commands as

USAGE
  $ box configure:environments:switch-user [USERID]

ARGUMENTS
  USERID  The user ID to switch to

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
  --default                              Switch to the default user, i.e. the Service Account
  --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

See code: src/commands/configure/environments/switch-user.js

box configure:environments:update [NAME]

Update a Box environment

USAGE
  $ box configure:environments:update [NAME]

ARGUMENTS
  NAME  The name of the environment

OPTIONS
  -h, --help                           Show CLI help
  -v, --verbose                        Show verbose output, which can be helpful for debugging
  --[no-]cache-tokens                  Enable token caching, which significantly improves performance
  --config-file-path=config-file-path  Provide a file path to configuration file
  --name=name                          New name of the environment
  --no-color                           Turn off colors for logging
  --private-key-path=private-key-path  Provide a file path to application private key

  --user-id=user-id                    Store a default user ID to use with the session commands. A default user ID can
                                       be stored for each Box environment

See code: src/commands/configure/environments/update.js

box configure:settings

View and update CLI configuration settings

USAGE
  $ box configure:settings

OPTIONS
  -h, --help                                     Show CLI help
  -v, --verbose                                  Show verbose output, which can be helpful for debugging
  --downloads-folder-path=downloads-folder-path  Set folder path for the downloads folder
  --file-format=csv|json|txt                     Set the file format for generated reports
  --no-color                                     Turn off colors for logging
  --[no-]output-json                             Default to JSON output for all commands
  --reports-folder-path=reports-folder-path      Set folder path for the reports folder

See code: src/commands/configure/settings.js

box device-pins

List all the device pins for your enterprise

USAGE
  $ box device-pins

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
  --direction=ASC|DESC                   Set sorting (by id) direction. Default is ASC
  --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

See code: src/commands/device-pins/index.js

box device-pins:delete ID

Delete individual device pin

USAGE
  $ box device-pins:delete ID

ARGUMENTS
  ID  ID of the device pin to delete

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

See code: src/commands/device-pins/delete.js

box device-pins:get ID

Get information about an individual device pin

USAGE
  $ box device-pins:get ID

ARGUMENTS
  ID  ID of the device pin to get

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

See code: src/commands/device-pins/get.js

box events

Get events

USAGE
  $ box events

OPTIONS
  -e, --enterprise                       Get enterprise events
  -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

  --created-after=created-after          Return enterprise events that occured after a time. Use a timestamp or
                                         shorthand syntax 0t, like 5w for 5 weeks. If not used, defaults to 5 days
                                         before the end date

  --created-before=created-before        Return enterprise events that occured before a time. Use a timestamp or
                                         shorthand syntax 0t, like 5w for 5 weeks. If not used, defaults to now

  --csv                                  Output formatted CSV

  --event-types=event-types              Return enterprise events filtered by event types. Format using a comma
                                         delimited list: NEW_USER,DELETE_USER,EDIT_USER

  --fields=fields                        Comma separated list of fields to show

  --json                                 Output formatted JSON

  --limit=limit                          The maximum number of items to return

  --no-color                             Turn off colors for logging

  --save-to-file-path=save-to-file-path  Override default file path to save report

  --stream-position=stream-position      The location in the event stream from which you want to start receiving events

ALIASES
  $ box events:get

See code: src/commands/events/index.js

box events:poll

Poll the event stream

USAGE
  $ box events:poll

OPTIONS
  -e, --enterprise                       Get enterprise events
  -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

  --end-date=end-date                    Return enterprise events that occured before this time. Use a timestamp or
                                         shorthand syntax 00t, like 05w for 5 weeks.

  --event-types=event-types              Return enterprise events filtered by event types. Format using a comma
                                         delimited list: NEW_USER,DELETE_USER,EDIT_USER

  --fields=fields                        Comma separated list of fields to show

  --json                                 Output formatted JSON

  --no-color                             Turn off colors for logging

  --polling-interval=polling-interval    Number of seconds to wait before polling for new events. Default is 60 seconds.

  --save-to-file-path=save-to-file-path  Override default file path to save report

  --start-date=start-date                Return enterprise events that occured after this time. Use a timestamp or
                                         shorthand syntax 00t, like 05w for 5 weeks. If not used, defaults to now

See code: src/commands/events/poll.js

box files:collaborations ID

List all collaborations on a file

USAGE
  $ box files:collaborations ID

ARGUMENTS
  ID  ID of the file to get collaborations for

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

ALIASES
  $ box files:collaborations:list

See code: src/commands/files/collaborations/index.js

box files:collaborations:add ID

Create a collaboration for a file

USAGE
  $ box files:collaborations:add ID

ARGUMENTS
  ID  ID of the file to add a collaboration to

OPTIONS
  -h, --help                                                                               Show CLI help

  -r, --role=editor|viewer|previewer|uploader|previewer_uploader|viewer_uploader|co-owner  An option to manually enter
                                                                                           the role

  -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

  --[no-]can-view-path                                                                     Whether view path
                                                                                           collaboration feature is
                                                                                           enabled or not

  --csv                                                                                    Output formatted CSV

  --fields=fields                                                                          Comma separated list of
                                                                                           fields to show

  --group-id=group-id                                                                      Id for group to collaborate

  --id-only                                                                                Return only an ID to output
                                                                                           from this command

  --json                                                                                   Output formatted JSON

  --login=login                                                                            Login for user to collaborate

  --no-color                                                                               Turn off colors for logging

  --[no-]notify                                                                            All users will receive email
                                                                                           notification of the
                                                                                           collaboration

  --save-to-file-path=save-to-file-path                                                    Override default file path to
                                                                                           save report

  --user-id=user-id                                                                        Id for user to collaborate

See code: src/commands/files/collaborations/add.js

box files:comments ID

List all comments on a file

USAGE
  $ box files:comments ID

ARGUMENTS
  ID  ID of the file to get comments for

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

ALIASES
  $ box comments:list

See code: src/commands/files/comments.js

box files:copy ID PARENTID

Copy a file to a different folder

USAGE
  $ box files:copy ID PARENTID

ARGUMENTS
  ID        ID of the file to copy
  PARENTID  ID of the new parent folder to copy the file into

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 

Current Tags

  • 2.1.0                                ...           latest (a month ago)

2 Versions

  • 2.1.0                                ...           a month ago
  • 2.0.0                                ...           4 months ago
Maintainers (2)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 16
Dependencies (19)
Dev Dependencies (16)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |