docs: Add generic commands to CLI docs (#4288)

Co-authored-by: stellarsquall <stellarsquall@protonmail.ch>
pull/4329/head
Dan Heath 2 years ago committed by GitHub
parent 50de448fee
commit 592d3c637b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

@ -0,0 +1,41 @@
---
layout: docs
page_title: delete - Command
description: |-
The "delete" command lets you delete Boundary resources.
---
# delete
Command: `boundary delete`
The `boundary delete` command lets you delete Boundary resources.
It is a generic command that runs a delete operation on a Boundary resource using the resource's ID.
When you run this command, Boundary interprets it as the type-specific command.
For example, if you enter the `delete` command with a storage bucket ID, Boundary runs the `storage-buckets delete` command.
Help, error, or cURL output from the command may show the full command syntax.
## Example
This example deletes a storage bucket with the ID `sb_1234567890`:
```shell-session
$ boundary delete -id sb_1234567890
```
## Usage
<CodeBlockConfig hideClipboard>
```shell-session
$ boundary delete [resource ID] [args]
```
</CodeBlockConfig>
### Command options
- `-id=<string>` - The ID of the resource you want to delete.
@include 'cmd-option-note.mdx'

@ -0,0 +1,41 @@
---
layout: docs
page_title: read - Command
description: |-
The "read" command lets you read Boundary resources.
---
# read
Command: `boundary read`
The `boundary read` command lets you read Boundary resources.
It is a generic command that runs a read operation on a Boundary resource using the resource's ID.
When you run this command, Boundary interprets it as the type-specific command.
For example, if you enter the `read` command with a storage bucket ID, Boundary runs the `storage-buckets read` command.
Help, error, or cURL output from the command may show the full command syntax.
## Example
This example reads a storage bucket with the ID `sb_1234567890`:
```shell-session
$ boundary read -id sb_1234567890
```
## Usage
<CodeBlockConfig hideClipboard>
```shell-session
$ boundary read [resource ID] [args]
```
</CodeBlockConfig>
### Command options
- `-id=<string>` - The ID of the resource you want to read.
@include 'cmd-option-note.mdx'

@ -0,0 +1,41 @@
---
layout: docs
page_title: update - Command
description: |-
The "update" command lets you update Boundary resources.
---
# update
Command: `boundary update`
The `boundary update` command lets you update Boundary resources.
It is a generic command that runs an update operation on a Boundary resource using the resource's ID.
When you run this command, Boundary interprets it as the type-specific command.
For example, if you enter the `update` command with a storage bucket ID, Boundary runs the `storage-buckets update` command.
Help, error, or cURL output from the command may show the full command syntax.
## Example
This example updates a storage bucket with the ID `sb_1234567890` to add the name `devops` and the description `storage bucket for DevOps`:
```shell-session
$ boundary update -id sb_1234567890 -name devops -description "storage bucket for DevOps"
```
## Usage
<CodeBlockConfig hideClipboard>
```shell-session
$ boundary update [resource ID] [args]
```
</CodeBlockConfig>
### Command options
- `-id=<string>` - The ID of the resource you want to update.
@include 'cmd-option-note.mdx'

@ -892,6 +892,10 @@
}
]
},
{
"title": "delete",
"path": "commands/delete"
},
{
"title": "dev",
"path": "commands/dev"
@ -1103,6 +1107,10 @@
}
]
},
{
"title": "read",
"path": "commands/read"
},
{
"title": "roles",
"routes": [
@ -1347,6 +1355,10 @@
}
]
},
{
"title": "update",
"path": "commands/update"
},
{
"title": "users",
"routes": [

Loading…
Cancel
Save