Elgato_dark/Olares
1
0
Fork 0
mirror of https://github.com/beclab/Olares synced 2026-04-21 13:37:46 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
Olares/docs/developer/install/cli/prepare.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

3.4 KiB
Raw Blame History

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).

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.
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.
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.
Version values follow the format x.y.z (e.g., 1.10.0) or include a build date (e.g., 1.10.0-20241109).
Refer to the GitHub Releases page for available versions.		 No Current version

Examples

# Uses JuiceFS as the root filesystem
olares-cli prepare --with-juicefs=true