Installation

Prerequisites

Before installing Codexa, ensure you have the following:

• Node.js: v20.0.0 or higher

  node --version  # Should be v20.0.0 or higher

• For Cloud LLM (Groq): A Groq API key from console.groq.com

Installation Methods

Choose the installation method that works best for your system:

Method 1: npm (Recommended)

Install Codexa globally using npm:

npmpnpmbun
npm install -g codexa

Verify installation:

codexa

Method 2: Homebrew (macOS)

Install codexa using Homebrew on macOS:

First, add the tap:

brew tap sahitya-chandra/codexa

Then install:

brew install codexa

Updating Codexa

To update codexa to the latest version:

If installed via npm:

npmpnpmbun
npm install -g codexa@latest

If installed via Homebrew:

brew upgrade codexa

Check your current version:

codexa --version

LLM Setup

Codexa requires an LLM to generate answers. You can use Groq (cloud).

Option 1: Using Groq (Cloud)

Groq provides fast cloud-based LLMs with a generous free tier and is the recommended option for most users.

Step 1: Get a Groq API Key

1. Visit console.groq.com
2. Sign up or log in
3. Navigate to API Keys section
4. Create a new API key
5. Copy your API key (starts with gsk_)

Step 2: Set API Key

Run the following command to securely save your API key:

codexa config set GROQ_API_KEY "gsk_your_api_key_here"

This will save the key to your local configuration file (.codexarc.json).

Step 3: Verify API Key is Set

codexa config get GROQ_API_KEY

Step 4: Configure Codexa

Codexa defaults to using Groq when you run codexa init. If you need to manually configure, edit .codexarc.json:

{
  "modelProvider": "groq",
  "model": "openai/gpt-oss-120b",
  "embeddingProvider": "local",
  "embeddingModel": "Xenova/all-MiniLM-L6-v2"
}