mirror of https://github.com/beclab/Olares synced 2026-04-21 13:37:46 +00:00

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

705 B

Raw Blame History

`disk`

Synopsis

The disk command provides a set of tools to manage storage resources in the Olares system. It is specifically used for managing LVM-based storage configurations.

olares-cli disk <subcommand>

Subcommands

Subcommand	Description
`extend`	Extends Olares storage capacity on LVM-based installations.
`list-unmounted`	Lists unmounted disks.

Options

Name	Shorthand	Usage
`--help`	`-h`	Displays help information.

Examples

# List all disks that are connected but not mounted
olares-cli disk list-unmounted

# Extend Olares storage by adding newly detected unmounted disks
olares-cli disk extend

705 B Raw Blame History

disk