Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: release 4.0.0 #562

Merged
merged 3 commits into from
Jan 28, 2025
Merged

chore: release 4.0.0 #562

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3931e02
chore: release 4.0.0
box-sdk-build Jan 28, 2025
2316dba
Update docs
congminh1254 Jan 28, 2025
3e976c5
Update CHANGELOG.md
congminh1254 Jan 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,22 @@

All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.

## [4.0.0](https://github.com/box/boxcli/compare/v3.16.0...v4.0.0) (2025-01-28)


### ⚠ BREAKING CHANGES

* Drop support old Node version and integrate typescript SDK ([#548](https://github.com/box/boxcli/issues/548)) ([22179ec](https://github.com/box/boxcli/commit/22179ecfc68b8dd315339ac204a7274d712d5a8e))
* Replace `@oclif/command` to `@oclif/core` library ([#553](https://github.com/box/boxcli/issues/553)) ([aed470b](https://github.com/box/boxcli/commit/aed470b22d28ed19040b4417e3143f3323b9a916))

### New Features and Enhancements

* Incognito browser option for box login ([#561](https://github.com/box/boxcli/issues/561)) ([a666766](https://github.com/box/boxcli/commit/a6667664d6b43fd80de9e57482b0f4138efcd6cf))

### Bug Fixes

* Respect using environment `defaultAsUserId` for CCG Auth and OAuth ([#554](https://github.com/box/boxcli/issues/554)) ([b3a691e](https://github.com/box/boxcli/commit/b3a691e8c886f7bb3a25ae8f7986f284a695f046))

## [3.16.0](https://github.com/box/boxcli/compare/v3.15.0...v3.16.0) (2024-11-25)


Expand Down
108 changes: 55 additions & 53 deletions docs/ai.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,67 +12,69 @@ Sends an AI request to supported LLMs and returns an answer

```
USAGE
$ 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?"
$ box ai:ask --prompt <value> --items <value>... [-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]

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
--items=<value>... (required) The items for the AI request
--json Output formatted JSON
--no-color Turn off colors for logging
--prompt=<value> (required) The prompt for the AI request
--save-to-file-path=<value> 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?"
```

_See code: [src/commands/ai/ask.js](https://github.com/box/boxcli/blob/v3.16.0/src/commands/ai/ask.js)_
_See code: [src/commands/ai/ask.js](https://github.com/box/boxcli/blob/v4.0.0/src/commands/ai/ask.js)_

## `box ai:text-gen`

Sends an AI request to supported LLMs and returns an answer specifically focused on the creation of new text.

```
USAGE
$ 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?"
$ box ai:text-gen --items <value>... --prompt <value> [-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]
[--dialogue-history <value>...]

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
--dialogue-history=<value>... The history of prompts and answers previously passed to the LLM.
--fields=<value> Comma separated list of fields to show
--items=<value>... (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=<value> (required) The prompt for the AI request
--save-to-file-path=<value> 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?"
```

_See code: [src/commands/ai/text-gen.js](https://github.com/box/boxcli/blob/v3.16.0/src/commands/ai/text-gen.js)_
_See code: [src/commands/ai/text-gen.js](https://github.com/box/boxcli/blob/v4.0.0/src/commands/ai/text-gen.js)_
18 changes: 13 additions & 5 deletions docs/autocomplete.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,31 @@ Display autocomplete installation instructions

## `box autocomplete [SHELL]`

display autocomplete installation instructions
Display autocomplete installation instructions.

```
USAGE
$ box autocomplete [SHELL]
$ box autocomplete [SHELL] [-r]

ARGUMENTS
SHELL shell type
SHELL (zsh|bash|powershell) Shell type

OPTIONS
FLAGS
-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/v0.1.0/src/commands/autocomplete/index.ts)_
_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.2.18/src/commands/autocomplete/index.js)_
Loading