Skip to content

install ​

Synopsis ​

The install command installs Olares on your system. It supports various options to customize the installation process, such as specifying directories, Kubernetes types, or Minikube profiles.

bash
olares-cli install [option]

Options ​

OptionShorthandUsageRequiredDefault
--base-dir-bSets the base directory for Olares.No$HOME/.olares
--help-hDisplays help information.NoN/A
--kubeSpecifies the Kubernetes type.
Supported types are k3s and k8s.
Nok3s
--profile-pSets the Minikube profile name. Only applicable on macOS.Noolares-0
--version-vSpecifies 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.
NoVersion installed in the prepare phase