Documentation

Everything you need to know about Kael-OS

Getting Started

📦

Installation

Step-by-step guide to install Kael-OS on Arch Linux and other distributions

🚀

Quick Start

Get up and running with Kael-OS in minutes

⚙️

Configuration

Configure AI models, providers, and system settings

Installation

Arch Linux (Recommended)

                # Quick install with auto-installer
curl -sSL https://kael.leroyonline.co.za/install.sh | bash

# Or install from AUR
paru -S kael-os-ai
# or
yay -S kael-os-ai
            

Other Linux Distributions

                # Download latest release
wget https://github.com/LeeTheOrc/kael-os/releases/latest/download/kael-os-linux.tar.gz

# Extract and install
tar -xzf kael-os-linux.tar.gz
cd kael-os
sudo ./install.sh
            

Build from Source

                # Clone repository
git clone https://github.com/LeeTheOrc/kael-os.git
cd Kael-OS-AI

# Install dependencies
./scripts/install-all.sh

# Build
cargo build --release --manifest-path Kael-OS-AI/src-tauri/Cargo.toml
            

Quick Start

After installation, follow these steps to get started:

Install Ollama: Kael-OS uses Ollama for local AI models
curl -fsSL https://ollama.com/install.sh | sh
Download a model: Choose a model that fits your hardware
ollama pull llama2 # or for better performance on modern hardware ollama pull mistral
Launch Kael-OS: Start the application
kael-os
Configure settings: Open Settings to configure your AI provider and model preferences
Start chatting: You're ready to use local AI!

Configuration

Kael-OS can be configured through the Settings panel or by editing configuration files directly.

AI Provider Settings

Configure which AI provider to use (Ollama, OpenAI API, etc.) and set your preferred models.

GPU Acceleration

Kael-OS automatically detects and uses GPU acceleration when available. Configure GPU settings in the Performance section.

Keyboard Shortcuts

                Ctrl+N     - New chat
Ctrl+,     - Open settings
Ctrl+K     - Focus search
Ctrl+Q     - Quit application
            

API Reference

Detailed API documentation for developers building on top of Kael-OS

Need Help?

Can't find what you're looking for? Join our community on Discord or check out the GitHub Discussions.