Olares/docs/developer/install/cli/stop.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.2 KiB

stop

Synopsis

The stop command is used to stop the components of an installed (or partially installed) Olares system.

olares-cli stop [option]

Options

Option Shorthand Usage Required Default
--check-interval Specifies the interval between checks for remaining processes during shutdown (e.g., 5s, 2m, 3h). No 10s
--help -h Displays help information. No N/A
--timeout Sets the maximum time to wait for a graceful shutdown before using SIGKILL (e.g., 5s, 2m, 3h). No 1m

Examples

# Stop the Olares system
olares-cli stop

# Adjust the timeout for shutdown
olares-cli stop --timeout 2m

# Specify a custom check interval
olares-cli stop --check-interval 5s