⬇️ AtomOS & Nucleus CLI Installation Guide

This guide explains how to install the Nucleus CLI and use it to deploy AtomOS and its components on supported Linux distributions.

Prerequisites

Run all commands as root (use sudo).
Supported distributions: AlmaLinux (RHEL), Ubuntu, Debian (x86_64 only).
Minimum: 2 CPU cores, 2GB RAM.
Internet access is required.

1. Install the Nucleus CLI

The recommended way to install the Nucleus CLI is via the official installer script:

curl -fsSL https://repo.elemento.cloud/get-atomos.sh | sudo bash

This will:

Download the latest nucleus CLI to /usr/bin/nucleus
Make it executable and add it to your PATH (if needed)
Set up a cron job to check for updates monthly

You can now use the nucleus command from anywhere.

2. Install AtomOS

For RHEL/AlmaLinux:

Compute Node:

sudo nucleus --install compute <on-prem | cloud>

Storage Node:

sudo nucleus --install storage <on-prem | cloud>

Full Node (Compute + Storage):

sudo nucleus --install full <on-prem | cloud>

For Ubuntu/Debian:

Storage Node only:
```
sudo nucleus --install Storage <on-prem | cloud>
```
Compute/Full packages are not available for Ubuntu/Debian.

Note: Choose on-prem or cloud installation based on where the host machine reside

after running the command, follow the instruction that nucleus will prompt

3. Network Bridge Setup

During installation, Nucleus will prompt you to select a network interface and will create a bridge (default: br0) using nmcli. Follow the prompts to select the correct interface for your environment.

To set up a bridge manually at any time:

sudo nucleus --bridge-setup

4. Module Installation

After AtomOS installation, Nucleus will offer to fetch and install additional modules from the Elemento repository. You can:

List available modules
Select modules to install interactively

sudo nucleus --modules

5. Vault Setup

If you install Storage or Full, Nucleus will set up the default Elemento vault and offer to create custom vaults with your chosen settings. Call nucleus to create new custom vaults:

sudo nucleus --vault-creator

6. Post-Install

Check installation:
```
sudo nucleus --verify-install
```
Show system info:
```
sudo nucleus --info
```
Restart your system to apply all changes.

7. Troubleshooting

Ensure you have root privileges.
If you encounter errors, check logs with:
```
sudo nucleus --logs
```
For help:
```
sudo nucleus --help
```

For more information, visit https://elemento.cloud