diff --git a/docs/ai.md b/docs/ai.md index 5fac210e..42c56d9f 100644 --- a/docs/ai.md +++ b/docs/ai.md @@ -12,31 +12,27 @@ Sends an AI request to supported LLMs and returns an answer ``` USAGE - $ box ai:ask --prompt --items ... [-t ] [--as-user ] [--no-color] [--json | - --csv] [-s | --save-to-file-path ] [--fields ] [--bulk-file-path ] [-h] [-v] [-y] [-q] - -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= 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= Provide an ID for a user - --bulk-file-path= File path to bulk .csv or .json objects - --csv Output formatted CSV - --fields= Comma separated list of fields to show - --items=... (required) The items for the AI request - --json Output formatted JSON - --no-color Turn off colors for logging - --prompt= (required) The prompt for the AI request - --save-to-file-path= Override default file path to save report - -DESCRIPTION - Sends an AI request to supported LLMs and returns an answer - -EXAMPLES - $ box ai:ask --items=id=12345,type=file --prompt "What is the status of this document?" + $ box ai:ask + +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 + --items=items (required) The items for the AI request + --json Output formatted JSON + --no-color Turn off colors for logging + --prompt=prompt (required) The prompt for the AI request + --save-to-file-path=save-to-file-path Override default file path to save report + +EXAMPLE + box ai:ask --items=id=12345,type=file --prompt "What is the status of this document?" ``` _See code: [src/commands/ai/ask.js](https://github.com/box/boxcli/blob/v3.16.0/src/commands/ai/ask.js)_ @@ -47,34 +43,36 @@ Sends an AI request to supported LLMs and returns an answer specifically focused ``` USAGE - $ box ai:text-gen --items ... --prompt [-t ] [--as-user ] [--no-color] [--json | - --csv] [-s | --save-to-file-path ] [--fields ] [--bulk-file-path ] [-h] [-v] [-y] [-q] - [--dialogue-history ...] - -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= 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= Provide an ID for a user - --bulk-file-path= File path to bulk .csv or .json objects - --csv Output formatted CSV - --dialogue-history=... The history of prompts and answers previously passed to the LLM. - --fields= Comma separated list of fields to show - --items=... (required) The items to be processed by the LLM, often files. The array can include - exactly one element. - --json Output formatted JSON - --no-color Turn off colors for logging - --prompt= (required) The prompt for the AI request - --save-to-file-path= Override default file path to save report - -DESCRIPTION - Sends an AI request to supported LLMs and returns an answer specifically focused on the creation of new text. - -EXAMPLES - $ box ai:text-gen --dialogue-history=prompt="What is the status of this document?",answer="It is in review",created-at="2024-07-09T11:29:46.835Z" --items=id=12345,type=file --prompt="What is the status of this document?" + $ box ai:text-gen + +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 + --dialogue-history=dialogue-history The history of prompts and answers previously passed to the LLM. + --fields=fields Comma separated list of fields to show + + --items=items (required) The items to be processed by the LLM, often files. The array can + include exactly one element. + + --json Output formatted JSON + + --no-color Turn off colors for logging + + --prompt=prompt (required) The prompt for the AI request + + --save-to-file-path=save-to-file-path Override default file path to save report + +EXAMPLE + box ai:text-gen --dialogue-history=prompt="What is the status of this document?",answer="It is in + review",created-at="2024-07-09T11:29:46.835Z" --items=id=12345,type=file --prompt="What is the status of this + document?" ``` _See code: [src/commands/ai/text-gen.js](https://github.com/box/boxcli/blob/v3.16.0/src/commands/ai/text-gen.js)_ diff --git a/docs/autocomplete.md b/docs/autocomplete.md index 7cef0a9a..4dea1763 100644 --- a/docs/autocomplete.md +++ b/docs/autocomplete.md @@ -7,31 +7,23 @@ Display autocomplete installation instructions ## `box autocomplete [SHELL]` -Display autocomplete installation instructions. +display autocomplete installation instructions ``` USAGE - $ box autocomplete [SHELL] [-r] + $ box autocomplete [SHELL] ARGUMENTS - SHELL (zsh|bash|powershell) Shell type + SHELL shell type -FLAGS +OPTIONS -r, --refresh-cache Refresh cache (ignores displaying instructions) -DESCRIPTION - Display autocomplete installation instructions. - EXAMPLES $ box autocomplete - $ box autocomplete bash - $ box autocomplete zsh - - $ box autocomplete powershell - $ box autocomplete --refresh-cache ``` -_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.2.11/src/commands/autocomplete/index.js)_ +_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v0.1.0/src/commands/autocomplete/index.ts)_ diff --git a/docs/collaboration-allowlist.md b/docs/collaboration-allowlist.md index 8207f067..dfe88d58 100644 --- a/docs/collaboration-allowlist.md +++ b/docs/collaboration-allowlist.md @@ -18,33 +18,32 @@ List collaboration allowlist entries ``` USAGE - $ box collaboration-allowlist [-t ] [--as-user ] [--no-color] [--json | --csv] [-s | --save-to-file-path - ] [--fields ] [--bulk-file-path ] [-h] [-v] [-y] [-q] [--max-items ] - -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= 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= Provide an ID for a user - --bulk-file-path= File path to bulk .csv or .json objects - --csv Output formatted CSV - --fields= Comma separated list of fields to show - --json Output formatted JSON - --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= Override default file path to save report - -DESCRIPTION - List collaboration allowlist entries - -EXAMPLES $ box collaboration-allowlist + +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 + +EXAMPLE + box collaboration-allowlist ``` _See code: [src/commands/collaboration-allowlist/index.js](https://github.com/box/boxcli/blob/v3.16.0/src/commands/collaboration-allowlist/index.js)_ @@ -55,35 +54,29 @@ Add a collaboration allowlist entry ``` USAGE - $ box collaboration-allowlist:add DOMAIN --direction inbound|outbound|both [-t ] [--as-user ] [--no-color] - [--json | --csv] [-s | --save-to-file-path ] [--fields ] [--bulk-file-path ] [-h] [-v] [-y] - [-q] + $ box collaboration-allowlist:add DOMAIN ARGUMENTS DOMAIN Domain to add to allowlist (e.g. box.com) -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= 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= Provide an ID for a user - --bulk-file-path= File path to bulk .csv or .json objects - --csv Output formatted CSV - --direction=