LinuxCommandLibrary

box

Interact with Box cloud storage from the terminal.

TLDR

Login to Box

$ box login
copy
List files in a folder
$ box folders:items [folder_id]
copy
Upload a file
$ box files:upload [file.txt] --parent-id [folder_id]
copy
Download a file
$ box files:download [file_id]
copy
Create a folder
$ box folders:create [parent_id] --name "[folder_name]"
copy
Search for files
$ box search "[query]"
copy
Get file information
$ box files:get [file_id]
copy
Share a file with a link
$ box shared-links:create [file_id] --type file
copy
Execute bulk operations from CSV
$ box bulk [commands.csv]
copy

SYNOPSIS

box command [options]

DESCRIPTION

box is the official command-line interface for Box cloud storage. It allows users to interact with Box APIs from the terminal, performing file operations, managing users, and automating workflows without writing code.
The CLI supports bulk operations using CSV files, making it useful for batch processing and administrative tasks.

PARAMETERS

--parent-id id

Parent folder ID for upload/create operations
--name name
Name for new items
--as-user id
Execute as another user (admin)
--csv
Output in CSV format
--json
Output in JSON format
--save
Save output to file
--fields list
Specify fields to return

SUBCOMMANDS

Files

files:upload, files:download, files:get, files:delete, files:copy, files:move
Folders
folders:create, folders:items, folders:get, folders:delete, folders:copy
Users
users:list, users:get, users:create, users:update
Search
search
Shared Links
shared-links:create, shared-links:get, shared-links:delete
Collaboration
collaborations:add, collaborations:list
Bulk
bulk (execute commands from CSV)

CAVEATS

Requires a Box Developer account and application configuration. OAuth 2.0 authentication is needed for user-level access. Some operations require admin privileges. Rate limits apply to API calls.

HISTORY

The Box CLI was released as an open-source project to provide command-line access to Box's cloud storage platform. It is built on Node.js and uses the Box API for all operations.

SEE ALSO

rclone(1), aws-s3(1), gsutil(1)

> TERMINAL_GEAR

Curated for the Linux community

Copied to clipboard

> TERMINAL_GEAR

Curated for the Linux community