Olares/docs/developer/install/cli/precheck.md
2025-07-17 11:58:59 +08:00

16 lines
No EOL
1.8 KiB
Markdown

# `precheck`
## Synopsis
The `precheck` command verifies whether the system environment satisfies all prerequisites required for Olares installation.
```bash
olares-cli precheck [option]
```
## Options
| Option | Shorthand | Usage | Required | Default |
|------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|-----------------------------------|
| `--base-dir`| `-b` | Sets the base directory for Olares. | No | `$HOME/.olares` |
| `--help` | `-h` | Displays help information. | No | N/A |
| `--version`| `-v` | Specifies the Olares version. <br>Version values follow the format `x.y.z` (e.g., `1.10.0`) or include a build date (e.g., `1.10.0-20241109`).<br> Refer to the [GitHub Releases page](https://github.com/beclab/Olares/releases) for available versions. | No | Current version |