OVERVIEW

ElexGPT is an open-source, highly capable AI coding agent designed to live directly in your terminal, desktop, and web browser. From planning massive architectural refactors to writing localized scripts, ElexGPT handles your development workflow with speed, safety, and a touch of personality.

✨ Meet the Mascot!

ElexGPT features a fully interactive, pixel-art Mascot that lives right inside your Terminal Chat Box! The mascot responds to the agent's current state:

  • 🌸 Idle: Waiting eagerly for your instructions.
  • 💭 Thinking / Action: Actively generating code or executing tasks.
  • ❓ Ask / Question: Asking for your permission before executing critical commands.
  • >_< Error: Reacting to unexpected errors or retries.

GETTING STARTED

Installation

ElexGPT is designed to run locally on your machine. You can easily install it using our quick setup script.

Quick Install

macOS / Linux:

curl -fsSL https://elexgpt.vercel.app/install | bash

Windows (PowerShell):

irm https://elexgpt.vercel.app/install.ps1 | iex

Once installed, verify the installation by running:

elexgpt --version

CONFIGURATION

API Keys

ElexGPT requires an API key to communicate with the underlying LLMs. Set it up using the config command:

elexgpt config set OPENAI_API_KEY=sk-...

Workspace Setup

Navigate to your project folder and initialize ElexGPT:

cd my-project
elexgpt init

This will create a `.elexgpt` folder inside your project where local configuration and memories are stored.

DOWNLOADS

If you prefer to download the CLI binaries directly instead of using the installation scripts, you can get them below:

COMMANDS

Below are the core commands you'll use daily to orchestrate the AI.

  • elexgpt chat
    Opens an interactive chat session with the agent in your terminal.
  • elexgpt execute "task"
    Instructs the agent to complete a specific task autonomously.
  • elexgpt review
    Runs a code review on your current git branch.
  • elexgpt config list
    Displays all your currently configured global settings and API keys.

AGENTS ARCHITECTURE

ElexGPT includes specialized agents tailored to different phases of development. You can seamlessly switch between them using the Tab key in the CLI or UI.

  • build
    Default, full-access agent for writing code and running commands. Capable of complete autonomous execution.
  • plan
    Read-only agent optimized for deep architectural analysis and exploration. Denies file edits and prompts for permission before running bash commands.
  • general
    An internal subagent designed for complex multi-step tasks (invoke using @general).