Getting started

Installation

Option A — pipx (recommended)

pipx install rays-core
pipx upgrade rays-core

Option B — pip

pip install rays-core
pip install --upgrade rays-core

Development install

git clone https://github.com/RAYS-CORE/RAYS-CORE.git
cd RAYS-CORE
python -m pip install -e .

Environment variables

RAYS reads API keys from the environment before prompting:

  • GEMINI_API_KEY — preferred Gemini key
  • GOOGLE_API_KEY — Gemini fallback

macOS / Linux

export GEMINI_API_KEY="your_gemini_key"
echo 'export GEMINI_API_KEY="your_gemini_key"' >> ~/.zshrc
source ~/.zshrc

Windows (PowerShell)

setx GEMINI_API_KEY "your_gemini_key"

Ollama (local provider)

Default endpoint is http://localhost:11434. Start the Ollama daemon before selecting the local provider in the launcher.