Skip to content

Commit 7eb074e

Browse files
committed
Merge pull request 'chore: update readme with new functionalities' (#190) from chore/update-readme-with-new-functionalities into main
Reviewed-on: https://gitea.obmondo.com/EnableIT/Linuxaid-cli/pulls/190
2 parents 13fd7d0 + 7d6875d commit 7eb074e

1 file changed

Lines changed: 49 additions & 12 deletions

File tree

README.md

Lines changed: 49 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,38 @@
22

33
> **Part of [Linuxaid](https://github.com/obmondo/linuxaid) by [Obmondo](https://obmondo.com)**
44
5+
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/Obmondo/linuxaid-cli)
6+
57
A Linux system management toolkit that automates Puppet-based configuration management and system updates across Obmondo-managed infrastructure. The project provides two command-line applications for initial provisioning and ongoing system maintenance.
68

9+
## Installation
10+
11+
### Quick Install (Recommended)
12+
13+
The easiest way to install `linuxaid-install` is using the installation script:
14+
15+
```bash
16+
curl -sSL https://raw.githubusercontent.com/Obmondo/linuxaid-cli/main/install.sh | bash
17+
```
18+
19+
This script will:
20+
21+
- Detect your system architecture (amd64, arm64, armv7)
22+
- Download the latest release from GitHub
23+
- Verify the checksum for security
24+
- Install the `linuxaid-install` binary to `/usr/local/bin`
25+
- Automatically run the installation tool
26+
27+
### Build from Source
28+
29+
If you prefer to build from source:
30+
31+
```bash
32+
make build
33+
```
34+
35+
This produces two binaries: `linuxaid-install` and `linuxaid-cli`.
36+
737
## Applications
838

939
### linuxaid-install
@@ -14,7 +44,7 @@ Initial system provisioning tool that installs and configures the Puppet agent (
1444

1545
```bash
1646
TOKEN='your-token'
17-
linuxaid-install --certname web01.example --puppet-server your.openvoxserver.com
47+
linuxaid-install --certname web01.example --puppet-server your.openvoxserver.com --openvox-environment master
1848
```
1949

2050
### linuxaid-cli
@@ -38,15 +68,7 @@ linuxaid-cli run-openvox --certname web01.example
3868
- **Automated Puppet Agent Management**: Complete lifecycle management including installation, configuration, and execution
3969
- **Remote Logging**: gRPC-based streaming of command execution output to Obmondo API
4070
- **Service Window Coordination**: Integrates with Obmondo backend for maintenance window management
41-
- **Multi-Distribution Support**: Ubuntu, Debian, RHEL, CentOS, SLES, and TurrisOS
42-
43-
## Building
44-
45-
```bash
46-
make build
47-
```
48-
49-
This produces two binaries: `linuxaid-install` and `linuxaid-cli`.
71+
- **Multi-Distribution Support**: Ubuntu, Debian, RHEL, CentOS, SLES, OracleLinux, and TurrisOS
5072

5173
## Configuration
5274

@@ -56,14 +78,29 @@ Configuration uses a three-tier precedence system via Viper:
5678
2. Environment variables
5779
3. Default values
5880

59-
**Key Parameters:**
81+
## Global Flags
82+
83+
These flags are available for both `linuxaid-install` and `linuxaid-cli`:
6084

6185
- `--certname` / `CERTNAME` - Certificate name (required)
62-
- `--puppet-server` / `PUPPET_SERVER` - Puppet server hostname
6386
- `--debug` / `DEBUG` - Enable debug logging
87+
88+
## `linuxaid-install` Specific Flags
89+
90+
- `--puppet-server` / `PUPPET_SERVER` - Puppet server hostname
91+
- `--openvox-environment` / `OPENVOX_ENVIRONMENT` - Openvox environment (Linuxaid release version)
92+
93+
## `linuxaid-cli` Command-Specific Flags
94+
95+
### system-update
96+
6497
- `--no-reboot` / `NO_REBOOT` - Disable automatic reboot after updates
6598
- `--skip-openvox` / `SKIP_OPENVOX` - Skip Puppet agent run
6699

100+
### run-openvox
101+
102+
No command-specific flags available. Uses global flags only.
103+
67104
## Dependencies
68105

69106
- Cobra for CLI framework

0 commit comments

Comments
 (0)