Dan HeathandRobin Beck
b442c1fa60
* docs: Update meta content - CLI * docs: Edits for consistency * docs: More edits for consistency * Apply batch of suggestions from code review Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com> * Apply batch suggestions from code review Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com> * docs: Remove given id references * Update read.mdx * Update read.mdx --------- Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>
36 lines
651 B
Plaintext
36 lines
651 B
Plaintext
---
|
|
layout: docs
|
|
page_title: workers read - Command
|
|
description: >-
|
|
The "workers read" command retrieves the details of a worker resource.
|
|
---
|
|
|
|
# workers read
|
|
|
|
Command: `boundary workers read`
|
|
|
|
The `boundary workers read` command lets you read a Boundary worker information for a given ID.
|
|
|
|
## Example
|
|
|
|
This example reads a worker with the ID `w_1234567890`:
|
|
|
|
```shell-session
|
|
$ boundary workers read -id w_1234567890
|
|
```
|
|
|
|
## Usage
|
|
|
|
<CodeBlockConfig hideClipboard>
|
|
|
|
```shell-session
|
|
$ boundary workers read [options] [args]
|
|
```
|
|
|
|
</CodeBlockConfig>
|
|
|
|
### Command options
|
|
|
|
- `id=<string>` - The ID of the worker to read.
|
|
|
|
@include 'cmd-option-note.mdx' |