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-list.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

list

Synopsis

The list subcommand displays a list of all registered users in the Olares system. You can sort, filter, and format the output to suit your needs.

Aliases: list, ls, l

olares-cli user list [options]

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
--reverse -r Reverses the sort order of the output. No N/A
--sort Sorts the output by a specific field.
Valid values: name, role, create-time, memory, cpu		 No N/A

Examples

# List all users in a table format
olares-cli user list

# List all users in JSON format
olares-cli user list -o json

# List users sorted by role
olares-cli user list --sort role