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
25 lines
No EOL
3.4 KiB
Markdown
25 lines
No EOL
3.4 KiB
Markdown
# `prepare`
|
|
|
|
## Synopsis
|
|
The `prepare` command sets up the environment required for Olares to function. This includes installing dependencies, importing container images, and starting the Olares daemon (`olaresd`).
|
|
```bash
|
|
olares-cli prepare [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 |
|
|
| `--kube` | | Specifies the Kubernetes type. <br>Supported types are `k3s` and `k8s`. | No | `k3s` |
|
|
| `--profile` | `-p` | Sets the Minikube profile name. Only applicable on macOS. | No | `olares-0` |
|
|
| `--registry-mirrors`| `-r` | Specifies Docker container registry mirrors. <br> Multiple mirrors should be separated by commas. | No | N/A |
|
|
| `--with-juicefs` | | Configures JuiceFS as the root filesystem (rootfs) for Olares workloads instead of the local disk. | 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 |
|
|
|
|
|
|
## Examples
|
|
```bash
|
|
# Uses JuiceFS as the root filesystem
|
|
olares-cli prepare --with-juicefs=true
|
|
``` |