Back to Meshery

mesheryctl-workspace-view

docs/content/en/reference/mesheryctl/workspace/view.md

1.0.181.8 KB
Original Source

mesheryctl workspace view

View a workspace

Synopsis

View a workspace by its ID or name.

<pre class='codeblock-pre'> <div class='codeblock'> mesheryctl workspace view [workspace-name|workspace-id] [flags] </div> </pre>

Examples

View details of a specific workspace by ID

<pre class='codeblock-pre'> <div class='codeblock'> mesheryctl workspace view [workspace-id] --orgId [orgId] </div> </pre>

View details of a specific workspace by name

<pre class='codeblock-pre'> <div class='codeblock'> mesheryctl workspace view [workspace-name] --orgId [orgId] </div> </pre>

View details of a specific workspace in JSON format

<pre class='codeblock-pre'> <div class='codeblock'> mesheryctl workspace view [workspace-id] --orgId [orgId] --output-format json </div> </pre>

View details of a specific workspace and save it to a file

<pre class='codeblock-pre'> <div class='codeblock'> mesheryctl workspace view [workspace-id] --orgId [orgId] --output-format json --save </div> </pre>

Options

<pre class='codeblock-pre'> <div class='codeblock'> -h, --help help for view --orgId string (required) organization ID -o, --output-format string (optional) format to display in [json|yaml] (default "yaml") -s, --save (optional) save output as a JSON/YAML file </div> </pre>

Options inherited from parent commands

<pre class='codeblock-pre'> <div class='codeblock'> --config string path to config file (default "/home/runner/.meshery/config.yaml") -v, --verbose verbose output </div> </pre>

See Also

Go back to command reference index, if you want to add content manually to the CLI documentation, please refer to the instruction for guidance.