Manage files
box files:collaborations IDbox files:collaborations:add IDbox files:comments IDbox files:copy ID PARENTIDbox files:delete IDbox files:download IDbox files:get IDbox files:lock IDbox files:metadata IDbox files:metadata:add IDbox files:metadata:get IDbox files:metadata:remove IDbox files:metadata:set IDbox files:metadata:update IDbox files:move ID PARENTIDbox files:rename ID NAMEbox files:share IDbox files:tasks IDbox files:unlock IDbox files:unshare IDbox files:update IDbox files:upload PATHbox files:versions FILEIDbox files:versions:delete FILEID FILEVERSIONIDbox files:versions:download FILEID FILEVERSIONIDbox files:versions:promote FILEID FILEVERSIONIDbox files:versions:upload FILEID PATHbox files:zip NAME
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
-q, --quiet Suppress any non-error output to stderr
-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
--max-items=max-items A value that indicates the maximum number of results to return. This only
specifies a maximum boundary and will not guarantee the minimum number of
results returned. When the max-items (x) is greater than 1000, then the maximum
ceil(x/1000) requests will be made.
--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
EXAMPLE
box files:collaborations 11111
See code: src/commands/files/collaborations/index.js
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
-q, --quiet Suppress any non-error output
to stderr
-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
EXAMPLE
box files:collaborations:add 11111 --role editor --user-id 22222
See code: src/commands/files/collaborations/add.js
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
-q, --quiet Suppress any non-error output to stderr
-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
EXAMPLE
box files:comments 11111
See code: src/commands/files/comments.js
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
-q, --quiet Suppress any non-error output to stderr
-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
--id-only Output only the ID of the file copy
--json Output formatted JSON
--name=name New name for the file
--no-color Turn off colors for logging
--save-to-file-path=save-to-file-path Override default file path to save report
--version=version File version ID if you want to copy a specific file version
EXAMPLE
box files:copy 11111 22222
See code: src/commands/files/copy.js
Delete a file
USAGE
$ box files:delete ID
ARGUMENTS
ID ID of the file to delete
OPTIONS
-f, --force Permanently delete the item, bypassing the trash
-h, --help Show CLI help
-q, --quiet Suppress any non-error output to stderr
-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
--etag=etag Only delete if etag value matches
--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
EXAMPLE
box files:delete 11111
See code: src/commands/files/delete.js
Download a file
USAGE
$ box files:download ID
ARGUMENTS
ID ID of the file to download
OPTIONS
-h, --help Show CLI help
-q, --quiet Suppress any non-error output to stderr
-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-]create-path Recursively creates a path to a directory if it does not exist
--csv Output formatted CSV
--destination=destination The destination folder to write the file to
--fields=fields Comma separated list of fields to show
--json Output formatted JSON
--no-color Turn off colors for logging
--[no-]overwrite Overwrite a file if it already exists
--save-as=save-as The filename used when saving the file
--save-to-file-path=save-to-file-path Override default file path to save report
--version=version File version ID of the specific file version to download
EXAMPLE
box files:download 11111 --destination /path/to/destinationFolder
See code: src/commands/files/download.js
Get information about a file
USAGE
$ box files:get ID
ARGUMENTS
ID ID of the file to get
OPTIONS
-h, --help Show CLI help
-q, --quiet Suppress any non-error output to stderr
-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
EXAMPLE
box files:get 11111
See code: src/commands/files/get.js
Lock a file
USAGE
$ box files:lock ID
ARGUMENTS
ID ID of file to lock
OPTIONS
-h, --help Show CLI help
-q, --quiet Suppress any non-error output to stderr
-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
--expires=expires Make the lock expire from a timespan set from now. Use s for seconds, m for
minutes, h for hours, d for days, w for weeks, M for months. For example, 30
seconds is 30s
--fields=fields Comma separated list of fields to show
--json Output formatted JSON
--no-color Turn off colors for logging
--[no-]prevent-download Prevent download of locked file
--save-to-file-path=save-to-file-path Override default file path to save report
ALIASES
$ box files:update-lock
EXAMPLE
box files:lock 11111
See code: src/commands/files/lock.js
Get all metadata on a file
USAGE
$ box files:metadata ID
ARGUMENTS
ID Id of the file
OPTIONS
-h, --help Show CLI help
-q, --quiet Suppress any non-error output to stderr
-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:metadata:get-all
EXAMPLE
box files:metadata 11111
See code: src/commands/files/metadata/index.js
Add metadata to a file
USAGE
$ box files:metadata:add ID
ARGUMENTS
ID ID of the file to add metadata to
OPTIONS
-h, --help Show CLI help
-q, --quiet Suppress any non-error output to stderr
-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
--data=data (required) Metadata key and value, in the form "key=value". Note: For float
type, use "#" at the beginning of digits: key2=#1234.50
--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
--scope=scope [default: enterprise] The scope of the metadata template to use
--template-key=template-key (required) The key of the metadata template to use
ALIASES
$ box files:metadata:create
EXAMPLES
box files:metadata:add 11111 --template-key employeeRecord --data "name=John Doe" --data department=Sales
box files:metadata:add 22222 --template-key myTemplate --data "multiselectkey1=[option1A,option1B]" --data
"multiselectkey2=[option2A]"
See code: src/commands/files/metadata/add.js
Get information about a metadata object
USAGE
$ box files:metadata:get ID
ARGUMENTS
ID ID of the file to get metadata on
OPTIONS
-h, --help Show CLI help
-q, --quiet Suppress any non-error output to stderr
-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
--scope=scope [default: enterprise] The scope of the metadata template to retrieve
--template-key=template-key (required) The key of the metadata template to retrieve
EXAMPLE
box files:metadata:get 11111 --template-key employeeRecord
See code: src/commands/files/metadata/get.js
Delete metadata from a file
USAGE
$ box files:metadata:remove ID
ARGUMENTS
ID ID of the file to remove metadata from
OPTIONS
-h, --help Show CLI help
-q, --quiet Suppress any non-error output to stderr
-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
--scope=scope [default: enterprise] The scope of the metadata template to remove
--template-key=template-key (required) The key of the metadata template to remove
ALIASES
$ box files:metadata:delete
EXAMPLE
box files:metadata:remove 11111 --scope global --template-key properties
See code: src/commands/files/metadata/remove.js
Set metadata on a file
USAGE
$ box files:metadata:set ID
ARGUMENTS
ID ID of the file to add metadata to
OPTIONS
-h, --help Show CLI help
-q, --quiet Suppress any non-error output to stderr
-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
--data=data (required) Metadata key and value, in the form "key=value". Note: For float
type, use "#" at the beginning of digits: key2=#1234.50
--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
--scope=scope [default: enterprise] The scope of the metadata template to use
--template-key=template-key (required) The key of the metadata template to use
EXAMPLES
box files:metadata:set 11111 --template-key employeeRecord --data "name=John Doe" --data department=Sales
box files:metadata:set 22222 --template-key myTemplate --data "multiselectkey1=[option1A,option1B]" --data
"multiselectkey2=[option2A]"
See code: src/commands/files/metadata/set.js
Update the metadata attached to a file
USAGE
$ box files:metadata:update ID
ARGUMENTS
ID ID of the file to update metadata on
OPTIONS
-a, --add=add Add a key to the metadata document; must be in the form key=value
-c, --copy=copy Copy a metadata value to another key; must be in the form
sourceKey>destinationKey
-h, --help Show CLI help
-m, --move=move Move a metadata value from one key to another; must be in the form
sourceKey>destinationKey
-q, --quiet Suppress any non-error output to stderr
-s, --save Save report to default reports folder on disk
-t, --test=test Test that a metadata key contains a specific value; must be in the form
key=value
-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
--remove=remove Remove a key from the metadata document
--replace=replace Replace the value of an existing metadata key; must be in the form key=value
--save-to-file-path=save-to-file-path Override default file path to save report
--scope=scope [default: enterprise] The scope of the metadata template to update against
--template-key=template-key (required) The key of the metadata template to update against
EXAMPLE
box files:metadata:update 11111 --template-key employeeRecord --replace department=Finance
See code: src/commands/files/metadata/update.js
Move a file to a different folder
USAGE
$ box files:move ID PARENTID
ARGUMENTS
ID ID of the file to move
PARENTID ID of the new parent folder to move the file into
OPTIONS
-h, --help Show CLI help
-q, --quiet Suppress any non-error output to stderr
-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
--etag=etag Only move if etag value matches
--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
EXAMPLE
box files:move 11111 22222
See code: src/commands/files/move.js
Rename a file
USAGE
$ box files:rename ID NAME
ARGUMENTS
ID ID of file to rename
NAME New name of file
OPTIONS
-h, --help Show CLI help
-q, --quiet Suppress any non-error output to stderr
-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
--description=description Change the file description
--etag=etag Only rename if etag value matches
--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
EXAMPLE
box files:rename 11111 "New File Name.pdf"
See code: src/commands/files/rename.js
Create a shared link for a file
USAGE
$ box files:share ID
ARGUMENTS
ID ID of the file to share
OPTIONS
-h, --help Show CLI help
-q, --quiet Suppress any non-error output to stderr
-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
--access=access Shared link access level
--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-download Whether the shared link allows downloads
--[no-]can-edit Whether the shared link allows edits. Only Applicable for files.
--csv Output formatted CSV
--fields=fields Comma separated list of fields to show
--json Output formatted JSON
--no-color Turn off colors for logging
--password=password Shared link password
--save-to-file-path=save-to-file-path Override default file path to save report
--unshared-at=unshared-at Time that this link will become disabled. Use s for seconds, m for minutes, h
for hours, d for days, w for weeks, M for months. For example, 30 seconds is
30s from now.
--vanity-name=vanity-name Defines a custom vanity name to use in the shared link URL. It should be
between 12 and 30 characters. This field can contains only letters, numbers and
hyphens.
ALIASES
$ box files:shared-links:create
$ box files:shared-links:update
EXAMPLE
box files:share 11111 --access company --vanity-name my-custom-name-123
See code: src/commands/files/share.js
List all tasks on this file
USAGE
$ box files:tasks ID
ARGUMENTS
ID ID of file on which to retrieve tasks
OPTIONS
-h, --help Show CLI help
-q, --quiet Suppress any non-error output to stderr
-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:tasks:list
EXAMPLE
box files:tasks 11111
See code: src/commands/files/tasks/index.js
Unlock a file
USAGE
$ box files:unlock ID
ARGUMENTS
ID Id of file to unlock
OPTIONS
-h, --help Show CLI help
-q, --quiet Suppress any non-error output to stderr
-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
EXAMPLE
box files:unlock 11111
See code: src/commands/files/unlock.js
Delete a shared link for a file
USAGE
$ box files:unshare ID
ARGUMENTS
ID ID of the file to unshare
OPTIONS
-h, --help Show CLI help
-q, --quiet Suppress any non-error output to stderr
-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:shared-links:delete
EXAMPLE
box files:unshare 11111
See code: src/commands/files/unshare.js
Update a file record
USAGE
$ box files:update ID
ARGUMENTS
ID ID of the file to update
OPTIONS
-h, --help Show CLI help
-q, --quiet Suppress any non-error output to stderr
-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
--description=description New description for the file
--disposition-at=disposition-at The retention expiration timestamp for the given file. This date cannot be
shortened once set on a file
--etag=etag Only apply updates if the ETag value matches
--fields=fields Comma separated list of fields to show
--json Output formatted JSON
--name=name New name for the file
--no-color Turn off colors for logging
--save-to-file-path=save-to-file-path Override default file path to save report
--tags=tags Set tags on the file, specified as comma-separated tags
EXAMPLE
box files:update 11111 --name "New File Name.pdf"
See code: src/commands/files/update.js
Upload a file
USAGE
$ box files:upload PATH
ARGUMENTS
PATH Path to the file to be uploaded
OPTIONS
-h, --help Show CLI help
-n, --name=name Provide different name for uploaded file
-p, --parent-id=parent-id [default: 0] ID of the parent folder to upload the file to; defaults to the
root folder
-q, --quiet Suppress any non-error output to stderr
-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
--content-created-at=content-created-at The creation date of the file content. Use a timestamp or shorthand syntax
0t, like 5w for 5 weeks
--content-modified-at=content-modified-at The modification date of the file content. Use a timestamp or shorthand
syntax 0t, like 5w for 5 weeks
--csv Output formatted CSV
--fields=fields Comma separated list of fields to show
--id-only Return only an ID to output from this command
--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
EXAMPLE
box files:upload /path/to/file.pdf --parent-id 22222
See code: src/commands/files/upload.js
Get a list of file versions
USAGE
$ box files:versions FILEID
ARGUMENTS
FILEID ID of file to get versions for
OPTIONS
-h, --help Show CLI help
-q, --quiet Suppress any non-error output to stderr
-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
--max-items=max-items A value that indicates the maximum number of results to return. This only
specifies a maximum boundary and will not guarantee the minimum number of
results returned. When the max-items (x) is greater than 1000, then the maximum
ceil(x/1000) requests will be made.
--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:versions:list
EXAMPLE
box files:versions 11111
See code: src/commands/files/versions/index.js
Delete a file version
USAGE
$ box files:versions:delete FILEID FILEVERSIONID
ARGUMENTS
FILEID ID of the file to get versions for
FILEVERSIONID ID of the file version to delete
OPTIONS
-h, --help Show CLI help
-q, --quiet Suppress any non-error output to stderr
-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
--etag=etag Only delete if etag value matches
--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
EXAMPLE
box files:versions:delete 11111 55555
See code: src/commands/files/versions/delete.js
Download a specific version of a file
USAGE
$ box files:versions:download FILEID FILEVERSIONID
ARGUMENTS
FILEID ID of the file to download
FILEVERSIONID ID of file version to download
OPTIONS
-h, --help Show CLI help
-q, --quiet Suppress any non-error output to stderr
-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-]create-path Recursively creates a path to a directory if it does not exist
--csv Output formatted CSV
--destination=destination The destination folder to write the file to
--fields=fields Comma separated list of fields to show
--json Output formatted JSON
--no-color Turn off colors for logging
--[no-]overwrite Overwrite a file if it already exists
--save-as=save-as The filename used when saving the file
--save-to-file-path=save-to-file-path Override default file path to save report
EXAMPLE
box files:versions:download 11111 55555
See code: src/commands/files/versions/download.js
Promote a file version
USAGE
$ box files:versions:promote FILEID FILEVERSIONID
ARGUMENTS
FILEID ID of the file to get versions for
FILEVERSIONID ID of the file version to delete
OPTIONS
-h, --help Show CLI help
-q, --quiet Suppress any non-error output to stderr
-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
EXAMPLE
box files:versions:promote 11111 55555
See code: src/commands/files/versions/promote.js
Upload a new version of a file
USAGE
$ box files:versions:upload FILEID PATH
ARGUMENTS
FILEID ID of the file to upload a new version of
PATH Local path to the file to upload
OPTIONS
-h, --help Show CLI help
-n, --name=name Provide different name for uploaded file
-q, --quiet Suppress any non-error output to stderr
-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
--content-modified-at=content-modified-at The last modification date of the file version. Use a timestamp or
shorthand syntax 0t, like 5w for 5 weeks
--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
EXAMPLE
box files:versions:upload 11111 /path/to/file.pdf
See code: src/commands/files/versions/upload.js
Create a zip of multiple files and folders and download it
USAGE
$ box files:zip NAME
ARGUMENTS
NAME Name of the zip to be created and downloaded
OPTIONS
-h, --help Show CLI help
-q, --quiet Suppress any non-error output to stderr
-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-]create-path Recursively creates a path to a directory if it does not exist
--csv Output formatted CSV
--destination=destination The destination folder to write the zip file to
--fields=fields Comma separated list of fields to show
--item=item (required) Files or folders to be part of zip in the form type:ID (i.e.
file:1374652)
--json Output formatted JSON
--no-color Turn off colors for logging
--[no-]overwrite Overwrite a zip file if it already exists
--save-to-file-path=save-to-file-path Override default file path to save report
EXAMPLE
box files:zip sample_file.zip --item=file:12421 --item=folder:48291
See code: src/commands/files/zip.js