Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
congminh1254 committed Jan 28, 2025
1 parent 3931e02 commit 2316dba
Show file tree
Hide file tree
Showing 39 changed files with 214 additions and 214 deletions.
4 changes: 2 additions & 2 deletions docs/ai.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ EXAMPLES
$ box ai:ask --items=id=12345,type=file --prompt "What is the status of this document?"
```

_See code: [src/commands/ai/ask.ts](https://github.com/box/boxcli/blob/v4.0.0/src/commands/ai/ask.ts)_
_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`

Expand Down Expand Up @@ -77,4 +77,4 @@ 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.ts](https://github.com/box/boxcli/blob/v4.0.0/src/commands/ai/text-gen.ts)_
_See code: [src/commands/ai/text-gen.js](https://github.com/box/boxcli/blob/v4.0.0/src/commands/ai/text-gen.js)_
2 changes: 1 addition & 1 deletion docs/autocomplete.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,4 @@ EXAMPLES
$ box autocomplete --refresh-cache
```

_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.2.18/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)_
16 changes: 8 additions & 8 deletions docs/collaboration-allowlist.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ EXAMPLES
$ box collaboration-allowlist
```

_See code: [src/commands/collaboration-allowlist/index.ts](https://github.com/box/boxcli/blob/v4.0.0/src/commands/collaboration-allowlist/index.ts)_
_See code: [src/commands/collaboration-allowlist/index.js](https://github.com/box/boxcli/blob/v4.0.0/src/commands/collaboration-allowlist/index.js)_

## `box collaboration-allowlist:add DOMAIN`

Expand Down Expand Up @@ -86,7 +86,7 @@ EXAMPLES
$ box collaboration-allowlist:add example.com --direction outbound
```

_See code: [src/commands/collaboration-allowlist/add.ts](https://github.com/box/boxcli/blob/v4.0.0/src/commands/collaboration-allowlist/add.ts)_
_See code: [src/commands/collaboration-allowlist/add.js](https://github.com/box/boxcli/blob/v4.0.0/src/commands/collaboration-allowlist/add.js)_

## `box collaboration-allowlist:delete ID`

Expand Down Expand Up @@ -122,7 +122,7 @@ EXAMPLES
$ box collaboration-allowlist:delete 12345
```

_See code: [src/commands/collaboration-allowlist/delete.ts](https://github.com/box/boxcli/blob/v4.0.0/src/commands/collaboration-allowlist/delete.ts)_
_See code: [src/commands/collaboration-allowlist/delete.js](https://github.com/box/boxcli/blob/v4.0.0/src/commands/collaboration-allowlist/delete.js)_

## `box collaboration-allowlist:exemptions`

Expand Down Expand Up @@ -159,7 +159,7 @@ EXAMPLES
$ box collaboration-allowlist:exemptions
```

_See code: [src/commands/collaboration-allowlist/exemptions/index.ts](https://github.com/box/boxcli/blob/v4.0.0/src/commands/collaboration-allowlist/exemptions/index.ts)_
_See code: [src/commands/collaboration-allowlist/exemptions/index.js](https://github.com/box/boxcli/blob/v4.0.0/src/commands/collaboration-allowlist/exemptions/index.js)_

## `box collaboration-allowlist:exemptions:create USERID`

Expand Down Expand Up @@ -195,7 +195,7 @@ EXAMPLES
$ box collaboration-allowlist:exemptions:create 11111
```

_See code: [src/commands/collaboration-allowlist/exemptions/create.ts](https://github.com/box/boxcli/blob/v4.0.0/src/commands/collaboration-allowlist/exemptions/create.ts)_
_See code: [src/commands/collaboration-allowlist/exemptions/create.js](https://github.com/box/boxcli/blob/v4.0.0/src/commands/collaboration-allowlist/exemptions/create.js)_

## `box collaboration-allowlist:exemptions:delete ID`

Expand Down Expand Up @@ -231,7 +231,7 @@ EXAMPLES
$ box collaboration-allowlist:exemptions:delete 12345
```

_See code: [src/commands/collaboration-allowlist/exemptions/delete.ts](https://github.com/box/boxcli/blob/v4.0.0/src/commands/collaboration-allowlist/exemptions/delete.ts)_
_See code: [src/commands/collaboration-allowlist/exemptions/delete.js](https://github.com/box/boxcli/blob/v4.0.0/src/commands/collaboration-allowlist/exemptions/delete.js)_

## `box collaboration-allowlist:exemptions:get ID`

Expand Down Expand Up @@ -267,7 +267,7 @@ EXAMPLES
$ box collaboration-allowlist:exemptions:get 12345
```

_See code: [src/commands/collaboration-allowlist/exemptions/get.ts](https://github.com/box/boxcli/blob/v4.0.0/src/commands/collaboration-allowlist/exemptions/get.ts)_
_See code: [src/commands/collaboration-allowlist/exemptions/get.js](https://github.com/box/boxcli/blob/v4.0.0/src/commands/collaboration-allowlist/exemptions/get.js)_

## `box collaboration-allowlist:get ID`

Expand Down Expand Up @@ -303,4 +303,4 @@ EXAMPLES
$ box collaboration-allowlist:get 12345
```

_See code: [src/commands/collaboration-allowlist/get.ts](https://github.com/box/boxcli/blob/v4.0.0/src/commands/collaboration-allowlist/get.ts)_
_See code: [src/commands/collaboration-allowlist/get.js](https://github.com/box/boxcli/blob/v4.0.0/src/commands/collaboration-allowlist/get.js)_
10 changes: 5 additions & 5 deletions docs/collaborations.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ EXAMPLES
$ box collaborations:create 22222 folder --role editor --user-id 33333
```

_See code: [src/commands/collaborations/create.ts](https://github.com/box/boxcli/blob/v4.0.0/src/commands/collaborations/create.ts)_
_See code: [src/commands/collaborations/create.js](https://github.com/box/boxcli/blob/v4.0.0/src/commands/collaborations/create.js)_

## `box collaborations:delete ID`

Expand Down Expand Up @@ -150,7 +150,7 @@ EXAMPLES
$ box collaborations:delete 12345
```

_See code: [src/commands/collaborations/delete.ts](https://github.com/box/boxcli/blob/v4.0.0/src/commands/collaborations/delete.ts)_
_See code: [src/commands/collaborations/delete.js](https://github.com/box/boxcli/blob/v4.0.0/src/commands/collaborations/delete.js)_

## `box collaborations:get ID`

Expand Down Expand Up @@ -186,7 +186,7 @@ EXAMPLES
$ box collaborations:get 12345
```

_See code: [src/commands/collaborations/get.ts](https://github.com/box/boxcli/blob/v4.0.0/src/commands/collaborations/get.ts)_
_See code: [src/commands/collaborations/get.js](https://github.com/box/boxcli/blob/v4.0.0/src/commands/collaborations/get.js)_

## `box collaborations:get-pending`

Expand Down Expand Up @@ -302,7 +302,7 @@ EXAMPLES
$ box collaborations:pending
```

_See code: [src/commands/collaborations/pending.ts](https://github.com/box/boxcli/blob/v4.0.0/src/commands/collaborations/pending.ts)_
_See code: [src/commands/collaborations/pending.js](https://github.com/box/boxcli/blob/v4.0.0/src/commands/collaborations/pending.js)_

## `box collaborations:update ID`

Expand Down Expand Up @@ -351,4 +351,4 @@ EXAMPLES
$ box collaborations:update 12345 --role viewer
```

_See code: [src/commands/collaborations/update.ts](https://github.com/box/boxcli/blob/v4.0.0/src/commands/collaborations/update.ts)_
_See code: [src/commands/collaborations/update.js](https://github.com/box/boxcli/blob/v4.0.0/src/commands/collaborations/update.js)_
8 changes: 4 additions & 4 deletions docs/collections.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ EXAMPLES
$ box collections
```

_See code: [src/commands/collections/index.ts](https://github.com/box/boxcli/blob/v4.0.0/src/commands/collections/index.ts)_
_See code: [src/commands/collections/index.js](https://github.com/box/boxcli/blob/v4.0.0/src/commands/collections/index.js)_

## `box collections:add ITEMTYPE ITEMID COLLECTIONID`

Expand Down Expand Up @@ -81,7 +81,7 @@ EXAMPLES
$ box collections:add file 11111 12345
```

_See code: [src/commands/collections/add.ts](https://github.com/box/boxcli/blob/v4.0.0/src/commands/collections/add.ts)_
_See code: [src/commands/collections/add.js](https://github.com/box/boxcli/blob/v4.0.0/src/commands/collections/add.js)_

## `box collections:items ID`

Expand Down Expand Up @@ -121,7 +121,7 @@ EXAMPLES
$ box collections:items 12345
```

_See code: [src/commands/collections/items.ts](https://github.com/box/boxcli/blob/v4.0.0/src/commands/collections/items.ts)_
_See code: [src/commands/collections/items.js](https://github.com/box/boxcli/blob/v4.0.0/src/commands/collections/items.js)_

## `box collections:list`

Expand Down Expand Up @@ -193,4 +193,4 @@ EXAMPLES
$ box collections:remove file 11111 12345
```

_See code: [src/commands/collections/remove.ts](https://github.com/box/boxcli/blob/v4.0.0/src/commands/collections/remove.ts)_
_See code: [src/commands/collections/remove.js](https://github.com/box/boxcli/blob/v4.0.0/src/commands/collections/remove.js)_
10 changes: 5 additions & 5 deletions docs/comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ EXAMPLES
$ box comments:create 11111 --message "Thanks for the update!"
```

_See code: [src/commands/comments/create.ts](https://github.com/box/boxcli/blob/v4.0.0/src/commands/comments/create.ts)_
_See code: [src/commands/comments/create.js](https://github.com/box/boxcli/blob/v4.0.0/src/commands/comments/create.js)_

## `box comments:delete ID`

Expand Down Expand Up @@ -84,7 +84,7 @@ EXAMPLES
$ box comments:delete 12345
```

_See code: [src/commands/comments/delete.ts](https://github.com/box/boxcli/blob/v4.0.0/src/commands/comments/delete.ts)_
_See code: [src/commands/comments/delete.js](https://github.com/box/boxcli/blob/v4.0.0/src/commands/comments/delete.js)_

## `box comments:get ID`

Expand Down Expand Up @@ -120,7 +120,7 @@ EXAMPLES
$ box comments:get 12345
```

_See code: [src/commands/comments/get.ts](https://github.com/box/boxcli/blob/v4.0.0/src/commands/comments/get.ts)_
_See code: [src/commands/comments/get.js](https://github.com/box/boxcli/blob/v4.0.0/src/commands/comments/get.js)_

## `box comments:list ID`

Expand Down Expand Up @@ -197,7 +197,7 @@ EXAMPLES
$ box comments:reply 12345 --message "No problem!"
```

_See code: [src/commands/comments/reply.ts](https://github.com/box/boxcli/blob/v4.0.0/src/commands/comments/reply.ts)_
_See code: [src/commands/comments/reply.js](https://github.com/box/boxcli/blob/v4.0.0/src/commands/comments/reply.js)_

## `box comments:update ID`

Expand Down Expand Up @@ -236,4 +236,4 @@ EXAMPLES
$ box comments:update 12345 --message "Thank you for the update!"
```

_See code: [src/commands/comments/update.ts](https://github.com/box/boxcli/blob/v4.0.0/src/commands/comments/update.ts)_
_See code: [src/commands/comments/update.js](https://github.com/box/boxcli/blob/v4.0.0/src/commands/comments/update.js)_
14 changes: 7 additions & 7 deletions docs/configure.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ DESCRIPTION
Add a new Box environment
```

_See code: [src/commands/configure/environments/add.ts](https://github.com/box/boxcli/blob/v4.0.0/src/commands/configure/environments/add.ts)_
_See code: [src/commands/configure/environments/add.js](https://github.com/box/boxcli/blob/v4.0.0/src/commands/configure/environments/add.js)_

## `box configure:environments:delete [NAME]`

Expand All @@ -83,7 +83,7 @@ DESCRIPTION
Delete a Box environment
```

_See code: [src/commands/configure/environments/delete.ts](https://github.com/box/boxcli/blob/v4.0.0/src/commands/configure/environments/delete.ts)_
_See code: [src/commands/configure/environments/delete.js](https://github.com/box/boxcli/blob/v4.0.0/src/commands/configure/environments/delete.js)_

## `box configure:environments:get`

Expand All @@ -105,7 +105,7 @@ DESCRIPTION
Get a Box environment
```

_See code: [src/commands/configure/environments/get.ts](https://github.com/box/boxcli/blob/v4.0.0/src/commands/configure/environments/get.ts)_
_See code: [src/commands/configure/environments/get.js](https://github.com/box/boxcli/blob/v4.0.0/src/commands/configure/environments/get.js)_

## `box configure:environments:select [ID]`

Expand Down Expand Up @@ -155,7 +155,7 @@ ALIASES
$ box configure:environments:select
```

_See code: [src/commands/configure/environments/set-current.ts](https://github.com/box/boxcli/blob/v4.0.0/src/commands/configure/environments/set-current.ts)_
_See code: [src/commands/configure/environments/set-current.js](https://github.com/box/boxcli/blob/v4.0.0/src/commands/configure/environments/set-current.js)_

## `box configure:environments:switch-user [USERID]`

Expand Down Expand Up @@ -189,7 +189,7 @@ DESCRIPTION
Switch the default Box user to run commands as
```

_See code: [src/commands/configure/environments/switch-user.ts](https://github.com/box/boxcli/blob/v4.0.0/src/commands/configure/environments/switch-user.ts)_
_See code: [src/commands/configure/environments/switch-user.js](https://github.com/box/boxcli/blob/v4.0.0/src/commands/configure/environments/switch-user.js)_

## `box configure:environments:update [NAME]`

Expand Down Expand Up @@ -221,7 +221,7 @@ DESCRIPTION
Update a Box environment
```

_See code: [src/commands/configure/environments/update.ts](https://github.com/box/boxcli/blob/v4.0.0/src/commands/configure/environments/update.ts)_
_See code: [src/commands/configure/environments/update.js](https://github.com/box/boxcli/blob/v4.0.0/src/commands/configure/environments/update.js)_

## `box configure:settings`

Expand Down Expand Up @@ -256,4 +256,4 @@ DESCRIPTION
View and update CLI configuration settings
```

_See code: [src/commands/configure/settings.ts](https://github.com/box/boxcli/blob/v4.0.0/src/commands/configure/settings.ts)_
_See code: [src/commands/configure/settings.js](https://github.com/box/boxcli/blob/v4.0.0/src/commands/configure/settings.js)_
6 changes: 3 additions & 3 deletions docs/device-pins.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ EXAMPLES
$ box device-pins
```

_See code: [src/commands/device-pins/index.ts](https://github.com/box/boxcli/blob/v4.0.0/src/commands/device-pins/index.ts)_
_See code: [src/commands/device-pins/index.js](https://github.com/box/boxcli/blob/v4.0.0/src/commands/device-pins/index.js)_

## `box device-pins:delete ID`

Expand Down Expand Up @@ -81,7 +81,7 @@ EXAMPLES
$ box device-pins:delete 12345
```

_See code: [src/commands/device-pins/delete.ts](https://github.com/box/boxcli/blob/v4.0.0/src/commands/device-pins/delete.ts)_
_See code: [src/commands/device-pins/delete.js](https://github.com/box/boxcli/blob/v4.0.0/src/commands/device-pins/delete.js)_

## `box device-pins:get ID`

Expand Down Expand Up @@ -117,4 +117,4 @@ EXAMPLES
$ box device-pins:get 12345
```

_See code: [src/commands/device-pins/get.ts](https://github.com/box/boxcli/blob/v4.0.0/src/commands/device-pins/get.ts)_
_See code: [src/commands/device-pins/get.js](https://github.com/box/boxcli/blob/v4.0.0/src/commands/device-pins/get.js)_
4 changes: 2 additions & 2 deletions docs/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ EXAMPLES
$ box events --enterprise --created-after 2019-01-01
```

_See code: [src/commands/events/index.ts](https://github.com/box/boxcli/blob/v4.0.0/src/commands/events/index.ts)_
_See code: [src/commands/events/index.js](https://github.com/box/boxcli/blob/v4.0.0/src/commands/events/index.js)_

## `box events:get`

Expand Down Expand Up @@ -246,4 +246,4 @@ DESCRIPTION
Poll the event stream
```

_See code: [src/commands/events/poll.ts](https://github.com/box/boxcli/blob/v4.0.0/src/commands/events/poll.ts)_
_See code: [src/commands/events/poll.js](https://github.com/box/boxcli/blob/v4.0.0/src/commands/events/poll.js)_
8 changes: 4 additions & 4 deletions docs/file-requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ EXAMPLES
$ box file-requests:copy 22222 44444
```

_See code: [src/commands/file-requests/copy.ts](https://github.com/box/boxcli/blob/v4.0.0/src/commands/file-requests/copy.ts)_
_See code: [src/commands/file-requests/copy.js](https://github.com/box/boxcli/blob/v4.0.0/src/commands/file-requests/copy.js)_

## `box file-requests:delete ID`

Expand Down Expand Up @@ -89,7 +89,7 @@ EXAMPLES
$ box file-requests:delete 12345
```

_See code: [src/commands/file-requests/delete.ts](https://github.com/box/boxcli/blob/v4.0.0/src/commands/file-requests/delete.ts)_
_See code: [src/commands/file-requests/delete.js](https://github.com/box/boxcli/blob/v4.0.0/src/commands/file-requests/delete.js)_

## `box file-requests:get ID`

Expand Down Expand Up @@ -125,7 +125,7 @@ EXAMPLES
$ box file-requests:get 12345
```

_See code: [src/commands/file-requests/get.ts](https://github.com/box/boxcli/blob/v4.0.0/src/commands/file-requests/get.ts)_
_See code: [src/commands/file-requests/get.js](https://github.com/box/boxcli/blob/v4.0.0/src/commands/file-requests/get.js)_

## `box file-requests:update ID`

Expand Down Expand Up @@ -172,4 +172,4 @@ EXAMPLES
$ box file-requests:update 12345 --description "New file request description!"
```

_See code: [src/commands/file-requests/update.ts](https://github.com/box/boxcli/blob/v4.0.0/src/commands/file-requests/update.ts)_
_See code: [src/commands/file-requests/update.js](https://github.com/box/boxcli/blob/v4.0.0/src/commands/file-requests/update.js)_
Loading

0 comments on commit 2316dba

Please sign in to comment.