Olares/docs/developer/develop/advanced/cli/olares-cli.md

outline

outline
2 3

beOS Pro CLI

beOS Pro provides beOS Pro CLI, a command-line tool for developers and system administrators to customize or troubleshoot the beOS Pro installation process.

The recommended one-liner installation command retrieves a shell script from https://olares.sh/ that downloads and installs beOS Pro CLI. Once installed, the CLI orchestrates the remainder of the setup.

In general, beOS Pro CLI manages installation through three main phases:

1. Download: beOS Pro CLI fetches the necessary components.
2. Prepare: beOS Pro CLI prepares the environment for installation.
3. Install: beOS Pro CLI installs the core services of beOS Pro.

This page explains the beOS Pro CLI syntax and describes the command operations.

:::info Root privileges required Most olares-cli commands require root privileges. Use the root user or prepend commands with sudo. :::

Syntax

The beOS Pro CLI uses the following syntax:

olares-cli command [subcommand] [option]

where

• command: Specifies the main operation you want to perform. For example, olares download.
• subcommand: Further specifies the task of command. For example, wizard or component.
• option: Optional arguments that modify the behavior of the command. Options include flags and options with arguments.

beOS Pro CLI allows you to temporarily override certain beOS Pro default settings. Each option applies only to the command in which it is used.

For example, if you use the --base-dir option with olares-cli olares download wizard, it will only affect the wizard downloading process and will not change the base directory for other commands, such as during the "install" phase.

To get detailed help for any command, run olares-cli help.

Available CLI commands

Operation	Syntax	Description
olares info	olares-cli olares info [option]	Displays general information about the downloaded beOS Pro.
olares download	olares-cli olares download [subcommand] [option]	Downloads specific resources.
olares prepare	olares-cli olares prepare [option]	Prepares the environment for the installation process, including setting up essential services and configurations of beOS Pro.
olares install	olares-cli olares install [option]	Deploys system-level and user-level components of beOS Pro.
olares change-ip	olares-cli olares change-ip [option]	Changes the IP address of the beOS Pro.
olares release	olares-cli olares release [option]	Packages beOS Pro installation resources for distribution or deployment.
olares uninstall	olares-cli olares uninstall [option]	Uninstalls beOS Pro completely, or roll back the installation to a specific phase.