List Box Hubs for the current user
box hubsbox hubs:collaborations IDbox hubs:collaborations:add IDbox hubs:collaborations:create IDbox hubs:collaborations:delete IDbox hubs:collaborations:get IDbox hubs:collaborations:list IDbox hubs:collaborations:update IDbox hubs:copy IDbox hubs:create TITLEbox hubs:delete IDbox hubs:document:blocks ID PAGEIDbox hubs:document:blocks:list ID PAGEIDbox hubs:document:pages IDbox hubs:document:pages:list IDbox hubs:enterprisebox hubs:get IDbox hubs:items IDbox hubs:items:list IDbox hubs:items:manage IDbox hubs:listbox hubs:update ID
List Box Hubs for the current user
USAGE
$ box hubs [-t <value>] [--as-user <value>] [--no-color] [--json | --csv] [-s | --save-to-file-path
<value>] [--fields <value>] [--bulk-file-path <value>] [-h] [-v] [-y] [-q] [--max-items <value>] [--query <value>]
[--scope editable|view_only|all] [--sort name|updated_at|last_accessed_at|view_count|relevance] [--direction
ASC|DESC]
FLAGS
-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=<value> 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=<value> Provide an ID for a user
--bulk-file-path=<value> File path to bulk .csv or .json objects
--csv Output formatted CSV
--direction=<option> Sort direction. One of: ASC, DESC
<options: ASC|DESC>
--fields=<value> Comma separated list of fields to show
--json Output formatted JSON
--max-items=<value> 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
--query=<value> Search query for Box Hubs
--save-to-file-path=<value> Override default file path to save report
--scope=<option> Scope of hubs to retrieve. One of: editable, view_only, all
<options: editable|view_only|all>
--sort=<option> Sort field for hubs. One of: name, updated_at, last_accessed_at, view_count,
relevance
<options: name|updated_at|last_accessed_at|view_count|relevance>
DESCRIPTION
List Box Hubs for the current user
ALIASES
$ box hubs:list
EXAMPLES
$ box hubs
$ box hubs --query "Product" --scope editable --sort name --direction ASC
See code: src/commands/hubs/index.js
List collaborations for a Box Hub
USAGE
$ box hubs:collaborations ID [-t <value>] [--as-user <value>] [--no-color] [--json | --csv] [-s | --save-to-file-path
<value>] [--fields <value>] [--bulk-file-path <value>] [-h] [-v] [-y] [-q] [--max-items <value>]
ARGUMENTS
ID ID of the Box Hub
FLAGS
-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=<value> 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=<value> Provide an ID for a user
--bulk-file-path=<value> File path to bulk .csv or .json objects
--csv Output formatted CSV
--fields=<value> Comma separated list of fields to show
--json Output formatted JSON
--max-items=<value> 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=<value> Override default file path to save report
DESCRIPTION
List collaborations for a Box Hub
ALIASES
$ box hubs:collaborations:list
EXAMPLES
$ box hubs:collaborations 12345
$ box hubs:collaborations 12345 --max-items 50
See code: src/commands/hubs/collaborations/index.js
Adds a collaboration with a specific role for a single user or a single group to a Box Hub. Collaborations can be created using email address, user IDs, or group IDs
USAGE
$ box hubs:collaborations:add ID -r editor|viewer|co-owner [-t <value>] [--as-user <value>] [--no-color] [--json | --csv]
[-s | --save-to-file-path <value>] [--fields <value>] [--bulk-file-path <value>] [-h] [-v] [-y] [-q] [--user-id
<value> | --group-id <value> | --login <value>]
ARGUMENTS
ID ID of the Box Hub
FLAGS
-h, --help Show CLI help
-q, --quiet Suppress any non-error output to stderr
-r, --role=<option> (required) Role to grant for the hub collaboration. One of: editor, viewer, co-owner
<options: editor|viewer|co-owner>
-s, --save Save report to default reports folder on disk
-t, --token=<value> 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=<value> Provide an ID for a user
--bulk-file-path=<value> File path to bulk .csv or .json objects
--csv Output formatted CSV
--fields=<value> Comma separated list of fields to show
--group-id=<value> Collaborate a group by Box group ID
--json Output formatted JSON
--login=<value> Collaborate a user by email address
--no-color Turn off colors for logging
--save-to-file-path=<value> Override default file path to save report
--user-id=<value> Collaborate a user by Box user ID
DESCRIPTION
Adds a collaboration with a specific role for a single user or a single group to a Box Hub. Collaborations can be
created using email address, user IDs, or group IDs
ALIASES
$ box hubs:collaborations:add
EXAMPLES
$ box hubs:collaborations:create 12345 --role editor --user-id 22222
$ box hubs:collaborations:create 12345 --role viewer --group-id 33333
$ box hubs:collaborations:create 12345 --role co-owner --login jdoe@example.com
Adds a collaboration with a specific role for a single user or a single group to a Box Hub. Collaborations can be created using email address, user IDs, or group IDs
USAGE
$ box hubs:collaborations:create ID -r editor|viewer|co-owner [-t <value>] [--as-user <value>] [--no-color] [--json | --csv]
[-s | --save-to-file-path <value>] [--fields <value>] [--bulk-file-path <value>] [-h] [-v] [-y] [-q] [--user-id
<value> | --group-id <value> | --login <value>]
ARGUMENTS
ID ID of the Box Hub
FLAGS
-h, --help Show CLI help
-q, --quiet Suppress any non-error output to stderr
-r, --role=<option> (required) Role to grant for the hub collaboration. One of: editor, viewer, co-owner
<options: editor|viewer|co-owner>
-s, --save Save report to default reports folder on disk
-t, --token=<value> 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=<value> Provide an ID for a user
--bulk-file-path=<value> File path to bulk .csv or .json objects
--csv Output formatted CSV
--fields=<value> Comma separated list of fields to show
--group-id=<value> Collaborate a group by Box group ID
--json Output formatted JSON
--login=<value> Collaborate a user by email address
--no-color Turn off colors for logging
--save-to-file-path=<value> Override default file path to save report
--user-id=<value> Collaborate a user by Box user ID
DESCRIPTION
Adds a collaboration with a specific role for a single user or a single group to a Box Hub. Collaborations can be
created using email address, user IDs, or group IDs
ALIASES
$ box hubs:collaborations:add
EXAMPLES
$ box hubs:collaborations:create 12345 --role editor --user-id 22222
$ box hubs:collaborations:create 12345 --role viewer --group-id 33333
$ box hubs:collaborations:create 12345 --role co-owner --login jdoe@example.com
See code: src/commands/hubs/collaborations/create.js
Delete a single Box Hub collaboration
USAGE
$ box hubs:collaborations:delete ID [-t <value>] [--as-user <value>] [--no-color] [--json | --csv] [-s | --save-to-file-path
<value>] [--fields <value>] [--bulk-file-path <value>] [-h] [-v] [-y] [-q]
ARGUMENTS
ID ID of the hub collaboration to delete
FLAGS
-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=<value> 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=<value> Provide an ID for a user
--bulk-file-path=<value> File path to bulk .csv or .json objects
--csv Output formatted CSV
--fields=<value> Comma separated list of fields to show
--json Output formatted JSON
--no-color Turn off colors for logging
--save-to-file-path=<value> Override default file path to save report
DESCRIPTION
Delete a single Box Hub collaboration
EXAMPLES
$ box hubs:collaborations:delete 99999
See code: src/commands/hubs/collaborations/delete.js
Retrieves details for a Box Hub collaboration by collaboration ID
USAGE
$ box hubs:collaborations:get ID [-t <value>] [--as-user <value>] [--no-color] [--json | --csv] [-s | --save-to-file-path
<value>] [--fields <value>] [--bulk-file-path <value>] [-h] [-v] [-y] [-q]
ARGUMENTS
ID ID of the hub collaboration
FLAGS
-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=<value> 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=<value> Provide an ID for a user
--bulk-file-path=<value> File path to bulk .csv or .json objects
--csv Output formatted CSV
--fields=<value> Comma separated list of fields to show
--json Output formatted JSON
--no-color Turn off colors for logging
--save-to-file-path=<value> Override default file path to save report
DESCRIPTION
Retrieves details for a Box Hub collaboration by collaboration ID
EXAMPLES
$ box hubs:collaborations:get 99999
See code: src/commands/hubs/collaborations/get.js
List collaborations for a Box Hub
USAGE
$ box hubs:collaborations:list ID [-t <value>] [--as-user <value>] [--no-color] [--json | --csv] [-s | --save-to-file-path
<value>] [--fields <value>] [--bulk-file-path <value>] [-h] [-v] [-y] [-q] [--max-items <value>]
ARGUMENTS
ID ID of the Box Hub
FLAGS
-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=<value> 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=<value> Provide an ID for a user
--bulk-file-path=<value> File path to bulk .csv or .json objects
--csv Output formatted CSV
--fields=<value> Comma separated list of fields to show
--json Output formatted JSON
--max-items=<value> 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=<value> Override default file path to save report
DESCRIPTION
List collaborations for a Box Hub
ALIASES
$ box hubs:collaborations:list
EXAMPLES
$ box hubs:collaborations 12345
$ box hubs:collaborations 12345 --max-items 50
Updates a Box Hub collaboration. Can be used to change the Box Hub role.
USAGE
$ box hubs:collaborations:update ID -r editor|viewer|co-owner [-t <value>] [--as-user <value>] [--no-color] [--json | --csv]
[-s | --save-to-file-path <value>] [--fields <value>] [--bulk-file-path <value>] [-h] [-v] [-y] [-q]
ARGUMENTS
ID ID of the hub collaboration to update
FLAGS
-h, --help Show CLI help
-q, --quiet Suppress any non-error output to stderr
-r, --role=<option> (required) Updated role for the hub collaboration. One of: editor, viewer, co-owner
<options: editor|viewer|co-owner>
-s, --save Save report to default reports folder on disk
-t, --token=<value> 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=<value> Provide an ID for a user
--bulk-file-path=<value> File path to bulk .csv or .json objects
--csv Output formatted CSV
--fields=<value> Comma separated list of fields to show
--json Output formatted JSON
--no-color Turn off colors for logging
--save-to-file-path=<value> Override default file path to save report
DESCRIPTION
Updates a Box Hub collaboration. Can be used to change the Box Hub role.
EXAMPLES
$ box hubs:collaborations:update 99999 --role viewer
See code: src/commands/hubs/collaborations/update.js
Copy a Box Hub
USAGE
$ box hubs:copy ID [-t <value>] [--as-user <value>] [--no-color] [--json | --csv] [-s | --save-to-file-path
<value>] [--fields <value>] [--bulk-file-path <value>] [-h] [-v] [-y] [-q] [-T <value>] [-d <value>]
ARGUMENTS
ID ID of the Box Hub to copy
FLAGS
-T, --title=<value> Optional title override for the copied hub
-d, --description=<value> Optional description override for the copied hub
-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=<value> 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=<value> Provide an ID for a user
--bulk-file-path=<value> File path to bulk .csv or .json objects
--csv Output formatted CSV
--fields=<value> Comma separated list of fields to show
--json Output formatted JSON
--no-color Turn off colors for logging
--save-to-file-path=<value> Override default file path to save report
DESCRIPTION
Copy a Box Hub
EXAMPLES
$ box hubs:copy 12345 --title "Copied hub title" --description "Copied hub description"
See code: src/commands/hubs/copy.js
Create a new Box Hub
USAGE
$ box hubs:create TITLE [-t <value>] [--as-user <value>] [--no-color] [--json | --csv] [-s |
--save-to-file-path <value>] [--fields <value>] [--bulk-file-path <value>] [-h] [-v] [-y] [-q] [-d <value>]
ARGUMENTS
TITLE Title for the Box Hub
FLAGS
-d, --description=<value> Description of the Box Hub
-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=<value> 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=<value> Provide an ID for a user
--bulk-file-path=<value> File path to bulk .csv or .json objects
--csv Output formatted CSV
--fields=<value> Comma separated list of fields to show
--json Output formatted JSON
--no-color Turn off colors for logging
--save-to-file-path=<value> Override default file path to save report
DESCRIPTION
Create a new Box Hub
EXAMPLES
$ box hubs:create "Roadmap Hub" --description "Q3 planning hub"
See code: src/commands/hubs/create.js
Delete a Box Hub
USAGE
$ box hubs:delete ID [-t <value>] [--as-user <value>] [--no-color] [--json | --csv] [-s | --save-to-file-path
<value>] [--fields <value>] [--bulk-file-path <value>] [-h] [-v] [-y] [-q]
ARGUMENTS
ID ID of the Box Hub to delete
FLAGS
-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=<value> 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=<value> Provide an ID for a user
--bulk-file-path=<value> File path to bulk .csv or .json objects
--csv Output formatted CSV
--fields=<value> Comma separated list of fields to show
--json Output formatted JSON
--no-color Turn off colors for logging
--save-to-file-path=<value> Override default file path to save report
DESCRIPTION
Delete a Box Hub
EXAMPLES
$ box hubs:delete 12345
See code: src/commands/hubs/delete.js
Retrieve sorted Hub Document Blocks for a specific hub document page, excluding items. Results are organized by parent_id and include only blocks on that page, not sub pages or their content blocks.
USAGE
$ box hubs:document:blocks ID PAGEID [-t <value>] [--as-user <value>] [--no-color] [--json | --csv] [-s |
--save-to-file-path <value>] [--fields <value>] [--bulk-file-path <value>] [-h] [-v] [-y] [-q] [--max-items <value>]
ARGUMENTS
ID ID of the Box Hub
PAGEID ID of the page in the Box Hub document
FLAGS
-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=<value> 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=<value> Provide an ID for a user
--bulk-file-path=<value> File path to bulk .csv or .json objects
--csv Output formatted CSV
--fields=<value> Comma separated list of fields to show
--json Output formatted JSON
--max-items=<value> 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=<value> Override default file path to save report
DESCRIPTION
Retrieve sorted Hub Document Blocks for a specific hub document page, excluding items. Results are organized by
parent_id and include only blocks on that page, not sub pages or their content blocks.
ALIASES
$ box hubs:document:blocks:list
EXAMPLES
$ box hubs:document:blocks 12345 55c8361a-012a-4fa1-a724-b7ef1cd87865
$ box hubs:document:blocks 12345 55c8361a-012a-4fa1-a724-b7ef1cd87865 --max-items 50
See code: src/commands/hubs/document/blocks.js
Retrieve sorted Hub Document Blocks for a specific hub document page, excluding items. Results are organized by parent_id and include only blocks on that page, not sub pages or their content blocks.
USAGE
$ box hubs:document:blocks:list ID PAGEID [-t <value>] [--as-user <value>] [--no-color] [--json | --csv] [-s |
--save-to-file-path <value>] [--fields <value>] [--bulk-file-path <value>] [-h] [-v] [-y] [-q] [--max-items <value>]
ARGUMENTS
ID ID of the Box Hub
PAGEID ID of the page in the Box Hub document
FLAGS
-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=<value> 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=<value> Provide an ID for a user
--bulk-file-path=<value> File path to bulk .csv or .json objects
--csv Output formatted CSV
--fields=<value> Comma separated list of fields to show
--json Output formatted JSON
--max-items=<value> 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=<value> Override default file path to save report
DESCRIPTION
Retrieve sorted Hub Document Blocks for a specific hub document page, excluding items. Results are organized by
parent_id and include only blocks on that page, not sub pages or their content blocks.
ALIASES
$ box hubs:document:blocks:list
EXAMPLES
$ box hubs:document:blocks 12345 55c8361a-012a-4fa1-a724-b7ef1cd87865
$ box hubs:document:blocks 12345 55c8361a-012a-4fa1-a724-b7ef1cd87865 --max-items 50
Retrieves a list of Hub Document Pages for the specified hub. Includes both root-level pages and sub pages
USAGE
$ box hubs:document:pages ID [-t <value>] [--as-user <value>] [--no-color] [--json | --csv] [-s | --save-to-file-path
<value>] [--fields <value>] [--bulk-file-path <value>] [-h] [-v] [-y] [-q] [--max-items <value>]
ARGUMENTS
ID ID of the Box Hub
FLAGS
-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=<value> 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=<value> Provide an ID for a user
--bulk-file-path=<value> File path to bulk .csv or .json objects
--csv Output formatted CSV
--fields=<value> Comma separated list of fields to show
--json Output formatted JSON
--max-items=<value> 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=<value> Override default file path to save report
DESCRIPTION
Retrieves a list of Hub Document Pages for the specified hub. Includes both root-level pages and sub pages
ALIASES
$ box hubs:document:pages:list
EXAMPLES
$ box hubs:document:pages 12345
$ box hubs:document:pages 12345 --max-items 50
See code: src/commands/hubs/document/pages.js
Retrieves a list of Hub Document Pages for the specified hub. Includes both root-level pages and sub pages
USAGE
$ box hubs:document:pages:list ID [-t <value>] [--as-user <value>] [--no-color] [--json | --csv] [-s | --save-to-file-path
<value>] [--fields <value>] [--bulk-file-path <value>] [-h] [-v] [-y] [-q] [--max-items <value>]
ARGUMENTS
ID ID of the Box Hub
FLAGS
-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=<value> 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=<value> Provide an ID for a user
--bulk-file-path=<value> File path to bulk .csv or .json objects
--csv Output formatted CSV
--fields=<value> Comma separated list of fields to show
--json Output formatted JSON
--max-items=<value> 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=<value> Override default file path to save report
DESCRIPTION
Retrieves a list of Hub Document Pages for the specified hub. Includes both root-level pages and sub pages
ALIASES
$ box hubs:document:pages:list
EXAMPLES
$ box hubs:document:pages 12345
$ box hubs:document:pages 12345 --max-items 50
List Box Hubs across the enterprise. This call requires an admin or hub co-admin of an enterprise with GCM scope. Otherwise, Box returns a 403 status code with the message The request requires higher privileges than provided by the access token. See https://developer.box.com/guides/api-calls/permissions-and-errors/scopes#global-content-manager-gcm
USAGE
$ box hubs:enterprise [-t <value>] [--as-user <value>] [--no-color] [--json | --csv] [-s | --save-to-file-path
<value>] [--fields <value>] [--bulk-file-path <value>] [-h] [-v] [-y] [-q] [--max-items <value>] [--query <value>]
[--sort name|updated_at|last_accessed_at|view_count|relevance] [--direction ASC|DESC]
FLAGS
-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=<value> 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=<value> Provide an ID for a user
--bulk-file-path=<value> File path to bulk .csv or .json objects
--csv Output formatted CSV
--direction=<option> Sort direction. One of: ASC, DESC
<options: ASC|DESC>
--fields=<value> Comma separated list of fields to show
--json Output formatted JSON
--max-items=<value> 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
--query=<value> Search query for enterprise Box Hubs
--save-to-file-path=<value> Override default file path to save report
--sort=<option> Sort field for hubs. One of: name, updated_at, last_accessed_at, view_count,
relevance
<options: name|updated_at|last_accessed_at|view_count|relevance>
DESCRIPTION
List Box Hubs across the enterprise. This call requires an admin or hub co-admin of an enterprise with GCM scope.
Otherwise, Box returns a 403 status code with the message `The request requires higher privileges than provided by the
access token.` See https://developer.box.com/guides/api-calls/permissions-and-errors/scopes#global-content-manager-gcm
EXAMPLES
$ box hubs:enterprise
$ box hubs:enterprise --query "Roadmap" --sort updated_at --direction DESC
See code: src/commands/hubs/enterprise.js
Get details for a Box Hub
USAGE
$ box hubs:get ID [-t <value>] [--as-user <value>] [--no-color] [--json | --csv] [-s | --save-to-file-path
<value>] [--fields <value>] [--bulk-file-path <value>] [-h] [-v] [-y] [-q]
ARGUMENTS
ID ID of the Box Hub
FLAGS
-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=<value> 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=<value> Provide an ID for a user
--bulk-file-path=<value> File path to bulk .csv or .json objects
--csv Output formatted CSV
--fields=<value> Comma separated list of fields to show
--json Output formatted JSON
--no-color Turn off colors for logging
--save-to-file-path=<value> Override default file path to save report
DESCRIPTION
Get details for a Box Hub
EXAMPLES
$ box hubs:get 12345
See code: src/commands/hubs/get.js
List items in a Box Hub
USAGE
$ box hubs:items ID [-t <value>] [--as-user <value>] [--no-color] [--json | --csv] [-s | --save-to-file-path
<value>] [--fields <value>] [--bulk-file-path <value>] [-h] [-v] [-y] [-q] [--max-items <value>] [--parent-id
<value>]
ARGUMENTS
ID ID of the Box Hub
FLAGS
-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=<value> 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=<value> Provide an ID for a user
--bulk-file-path=<value> File path to bulk .csv or .json objects
--csv Output formatted CSV
--fields=<value> Comma separated list of fields to show
--json Output formatted JSON
--max-items=<value> 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
--parent-id=<value> Filter to items that belong to a specific item list block in the Box Hub
--save-to-file-path=<value> Override default file path to save report
DESCRIPTION
List items in a Box Hub
ALIASES
$ box hubs:items:list
EXAMPLES
$ box hubs:items 12345
$ box hubs:items 12345 --parent-id 67890 --max-items 50
See code: src/commands/hubs/items/index.js
List items in a Box Hub
USAGE
$ box hubs:items:list ID [-t <value>] [--as-user <value>] [--no-color] [--json | --csv] [-s | --save-to-file-path
<value>] [--fields <value>] [--bulk-file-path <value>] [-h] [-v] [-y] [-q] [--max-items <value>] [--parent-id
<value>]
ARGUMENTS
ID ID of the Box Hub
FLAGS
-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=<value> 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=<value> Provide an ID for a user
--bulk-file-path=<value> File path to bulk .csv or .json objects
--csv Output formatted CSV
--fields=<value> Comma separated list of fields to show
--json Output formatted JSON
--max-items=<value> 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
--parent-id=<value> Filter to items that belong to a specific item list block in the Box Hub
--save-to-file-path=<value> Override default file path to save report
DESCRIPTION
List items in a Box Hub
ALIASES
$ box hubs:items:list
EXAMPLES
$ box hubs:items 12345
$ box hubs:items 12345 --parent-id 67890 --max-items 50
Add or remove items in a Box Hub
USAGE
$ box hubs:items:manage ID [-t <value>] [--as-user <value>] [--no-color] [--json | --csv] [-s | --save-to-file-path
<value>] [--fields <value>] [--bulk-file-path <value>] [-h] [-v] [-y] [-q] [--add <value>...] [--remove <value>...]
ARGUMENTS
ID ID of the Box Hub
FLAGS
-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=<value> 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
--add=<value>... Add an item to the Box Hub. Format: id=ITEM_ID,type=TYPE,parent-id=PARENT_ID.
Supported types are file, folder, web_link. The parent-id is the ID of the parent
block to add the item to. It must be an Item List block. If not provided, the item
will be added to the first page's first Item List block.
--as-user=<value> Provide an ID for a user
--bulk-file-path=<value> File path to bulk .csv or .json objects
--csv Output formatted CSV
--fields=<value> Comma separated list of fields to show
--json Output formatted JSON
--no-color Turn off colors for logging
--remove=<value>... Remove an item from the Box Hub. Format: id=ITEM_ID,type=TYPE. Supported types are
file, folder, web_link.
--save-to-file-path=<value> Override default file path to save report
DESCRIPTION
Add or remove items in a Box Hub
EXAMPLES
$ box hubs:items:manage 12345 --add id=11111,type=file,parent-id=67890
$ box hubs:items:manage 12345 --remove id=22222,type=folder
See code: src/commands/hubs/items/manage.js
List Box Hubs for the current user
USAGE
$ box hubs:list [-t <value>] [--as-user <value>] [--no-color] [--json | --csv] [-s | --save-to-file-path
<value>] [--fields <value>] [--bulk-file-path <value>] [-h] [-v] [-y] [-q] [--max-items <value>] [--query <value>]
[--scope editable|view_only|all] [--sort name|updated_at|last_accessed_at|view_count|relevance] [--direction
ASC|DESC]
FLAGS
-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=<value> 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=<value> Provide an ID for a user
--bulk-file-path=<value> File path to bulk .csv or .json objects
--csv Output formatted CSV
--direction=<option> Sort direction. One of: ASC, DESC
<options: ASC|DESC>
--fields=<value> Comma separated list of fields to show
--json Output formatted JSON
--max-items=<value> 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
--query=<value> Search query for Box Hubs
--save-to-file-path=<value> Override default file path to save report
--scope=<option> Scope of hubs to retrieve. One of: editable, view_only, all
<options: editable|view_only|all>
--sort=<option> Sort field for hubs. One of: name, updated_at, last_accessed_at, view_count,
relevance
<options: name|updated_at|last_accessed_at|view_count|relevance>
DESCRIPTION
List Box Hubs for the current user
ALIASES
$ box hubs:list
EXAMPLES
$ box hubs
$ box hubs --query "Product" --scope editable --sort name --direction ASC
Update a Box Hub
USAGE
$ box hubs:update ID [-t <value>] [--as-user <value>] [--no-color] [--json | --csv] [-s | --save-to-file-path
<value>] [--fields <value>] [--bulk-file-path <value>] [-h] [-v] [-y] [-q] [-T <value>] [-d <value>] [--ai-enabled]
[--collaboration-restricted-to-enterprise] [--can-non-owners-invite] [--can-shared-link-be-created]
[--can-public-shared-link-be-created]
ARGUMENTS
ID ID of the Box Hub to update
FLAGS
-T, --title=<value> Updated title for the Box Hub
-d, --description=<value> Updated description for the Box Hub
-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=<value> 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
--[no-]ai-enabled Enable or disable AI features for this Box Hub
--as-user=<value> Provide an ID for a user
--bulk-file-path=<value> File path to bulk .csv or .json objects
--[no-]can-non-owners-invite Allow non-owners to invite collaborators
--[no-]can-public-shared-link-be-created Allow public shared links for this Box Hub
--[no-]can-shared-link-be-created Allow shared links for this Box Hub
--[no-]collaboration-restricted-to-enterprise Restrict collaboration to enterprise users only
--csv Output formatted CSV
--fields=<value> Comma separated list of fields to show
--json Output formatted JSON
--no-color Turn off colors for logging
--save-to-file-path=<value> Override default file path to save report
DESCRIPTION
Update a Box Hub
EXAMPLES
$ box hubs:update 12345 --title "Updated title" --ai-enabled
See code: src/commands/hubs/update.js