A full list of CLI commands and usage information can be found in the
GitHub repository.
Only Service Accounts and Admins are able to use some commands.
If your user is not authorized with the necessary scopes or you
configured your CLI to obtain a default token for another user, calls may
fail. Add -v or --verbose to your command for verbose error logging.
If you do not see a command for an endpoint you need, you can build a
custom request.
Use repository documentation in conjunction with reference documentation to
see information the help command does not provide. This includes
restrictions, token permission requirements, fields, etc.
Using help to create a folder
Every CLI command begins with box. Append the --help flag to any CLI command to display usage information, available actions, and required arguments.
For example, executing box --help shows you
to a list of all possible resource commands, such as folders, files, and users. More information is available in
.
Then, for example, use the folder object and execute the command
box folders --help. This provides a list of all eligible actions for this
object.
Discover the required arguments for creating a folder: box folders:create --help
Execute the command box folders:create 0 "My CLI Folder" and note the folder
ID returned in the response.
The root level of the folder tree, the All Files page, is always represented
by folder ID 0.
Log into your Box account and verify that the folder appears.
If you set up the Box CLI using JWT authentication, you will not see the
folder in your Box account. The folder will live in the service account
of the application that was created after application approval.