Installation Guide¶

This guide walks you through the process of installing Oblix on your macOS system.

System Requirements¶

Operating System: macOS 11 (Big Sur) or newer
Python Versions: 3.9, 3.10, 3.11, 3.12, 3.13
Storage: 800 MB of free disk space
Memory: 8 GB RAM recommended
Internet Connection: Required for cloud model access

Installation with pip¶

The recommended way to install Oblix is using pip:

pip install oblix

For a specific Python version (if you have multiple Python versions installed):

python3.11 -m pip install oblix

Verify Installation¶

After installation, verify that Oblix is properly installed:

oblix --version

You should see the current version of Oblix displayed.

Using Oblix¶

After installation, you'll need to set up environment variables before using Oblix from the Terminal.

Required Environment Variables¶

For Oblix to function properly, you must set the following environment variables:

OBLIX_API_KEY - Your Oblix API key
OPENAI_API_KEY - Your OpenAI API key (for using GPT models)
ANTHROPIC_API_KEY - Your Anthropic API key (for using Claude models)

You can set these in your terminal session or add them to your shell profile for persistence:

# Add these lines to your ~/.zshrc or ~/.bash_profile
export OBLIX_API_KEY="your_oblix_api_key_here"
export OPENAI_API_KEY="your_openai_api_key_here"
export ANTHROPIC_API_KEY="your_anthropic_api_key_here"

After adding these to your profile file, apply the changes:

source ~/.zshrc  # or source ~/.bash_profile

Using the CLI¶

Once environment variables are set, you can use Oblix from the Terminal:

# Get help with available commands
oblix --help

# Start an interactive chat session
oblix chat --local-model llama2 --cloud-model gpt-3.5-turbo

You can also provide API keys directly in commands:

oblix chat --local-model llama2 --cloud-model gpt-3.5-turbo --cloud-api-key "your_api_key_here"

Virtual Environment (Recommended)¶

It's recommended to install Oblix in a virtual environment:

# Create and activate virtual environment
python -m venv oblix-env
source oblix-env/bin/activate  # On Windows: oblix-env\Scripts\activate

# Install Oblix
pip install oblix

Installing Ollama (Required for Local Models)¶

To use local models with Oblix, you'll need to install Ollama:

Download Ollama from ollama.ai
Follow the installation instructions for macOS
Verify Ollama is running by opening Terminal and typing:
```
ollama list
```

Troubleshooting¶

Common Issues¶

Issue: Command not found when trying to use Oblix in Terminal Solution: Make sure the installation completed successfully. You might need to restart your Terminal or add the Python scripts directory to your PATH.

Issue: Permission error during installation Solution: Try installing with pip install --user oblix or use a virtual environment.

Issue: Import errors after installation Solution: Ensure you're using a supported Python version (3.9, 3.10, 3.11, 3.12, or 3.13).

Getting Help¶

If you encounter issues during installation:

Join our Discord community: https://discord.gg/v8qtEVuU
Contact support at [email protected]

Uninstallation¶

To uninstall Oblix:

Pip Installation¶

If you installed Oblix using pip:

pip uninstall oblix

Configuration Files¶

To remove configuration files (optional):

rm -rf ~/.oblix