mirror of
https://github.com/beclab/Olares
synced 2026-04-21 21:47:56 +00:00
8133704761
* 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
28 lines
No EOL
1.2 KiB
Markdown
28 lines
No EOL
1.2 KiB
Markdown
# `stop`
|
|
|
|
## Synopsis
|
|
The `stop` command is used to stop the components of an installed (or partially installed) Olares system.
|
|
|
|
```bash
|
|
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
|
|
```bash
|
|
# 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
|
|
``` |