Elgato_dark/Olares
1
0
Fork 0
mirror of https://github.com/beclab/Olares synced 2026-04-21 13:37:46 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
Olares/docs/developer/install/cli/user-get.md
Meow33 8133704761
docs: add CLI docs for user, upgrade, and disk commands (#2383) 
* docs: add CLI docs for user, upgrade, and disk commands

* docs: update based on comments

* docs: fix typo

* docs: refine formatting and add description for argument

* docs: resolve conflicts
2026-01-13 17:30:57 +08:00

1 KiB
Raw Blame History

get

Synopsis

The get subcommand retrieves detailed information about a specific Olares user account. The output can be formatted as a table or JSON.

olares-cli user get <name> [options]

Arguments

Argument Description Required
<name> Specifies the username of the account to retrieve.
It is typically the part before the @ symbol in an Olares ID.
For example, alice123 for alice123@olares.com.		 Yes

Options

Option Shorthand Usage Required Default
--help -h Displays help information. No N/A
--kubeconfig Specifies the path to a kubeconfig file. No N/A
--no-headers Disables the header row in the output. No N/A
--output -o Specifies the output format. Valid values: table, json. No table

Examples

# Get details for user named alice123 in default table format
olares-cli user get alice123

# Get details for user named blake123 in JSON format
olares-cli user get blake123 -o json