β€” documentation

Alphacode

The AI coding agent that turns plain English into working code β€” right in your terminal.

πŸͺ„ In one sentence

**Alphacode is a free, open-source AI assistant that lives on your computer and writes, fixes, tests, and explains code for you β€” you just tell it what you want in plain English.**

Think of it like ChatGPT, except instead of only talking about code, it actually opens your files, makes the changes, runs the tests, and tells you what it did β€” safely, and with your permission at every risky step.

It works with all the major AI models β€” Claude, GPT-4/GPT-5, Gemini, GitHub Copilot, Cursor, and others β€” so you're never locked into one company's AI.


πŸ†• I'm brand new to this. Start here.

πŸ‘‰ Click to expand: "What even is Alphacode, in normal words?"

You don't need to be a programmer to use Alphacode's core idea β€” you tell it a goal, and it does the technical work. But Alphacode itself is a tool for working with code, so it does require one thing: a terminal (also called a "command line" or "console").

If you are...What that means for you
πŸ§‘β€πŸ’» **A developer / student learning to code**You'll feel at home immediately β€” skip to [Quick Start](#-quick-start-your-first-5-minutes)
πŸ§‘β€πŸŽ¨ **A designer, PM, founder, or hobbyist with zero coding background**You *can* absolutely use this. Read [What is a terminal?](#-what-is-a-terminal-and-do-i-need-to-learn-one) below first β€” it's a 3-minute read
🏒 **Evaluating this for a team or company**See [Why Alphacode](#-why-people-choose-alphacode) and [Safety](#-safety--how-alphacode-protects-your-computer)

πŸ’‘ What is a "terminal," and do I need to learn one?

A terminal is just a text window where you type commands instead of clicking buttons β€” like a chat box, but for talking to your computer directly. It looks intimidating the first time, but you really only need to know three things to use Alphacode:

  1. How to open it β€” every operating system has one built in (see below).
  2. How to copy-paste a command β€” you copy a line of text from this page and paste it in. That's most of what "using the terminal" means here.
  3. How to press Enter β€” that's it.

πŸ’» Windows 🍎 macOS 🐧 Linux

Press Win key β†’ type "PowerShell" β†’ press Enter

Press Cmd + Space β†’ type "Terminal" β†’ press Enter

Press Ctrl + Alt + T (most distros)

Once it's open, everything below just works by copy-pasting one line at a time. If something looks like an error, jump straight to Troubleshooting β€” every common issue has a copy-paste fix.


🧭 What is Alphacode, really? (The technical explanation)

For readers who want the precise version: Alphacode is a terminal-native AI coding agent. Give it an objective in natural language, and it:

  • reads and understands your codebase,
  • plans the work,
  • picks the best available AI model for the job,
  • edits files, runs shell commands, and executes tests,
  • searches the web when it needs current information,
  • coordinates multiple AI agents in parallel for large tasks,
  • reviews its own work before calling anything "done,"
  • and keeps the session alive β€” resumable, crash-safe β€” until the objective is genuinely complete.

Every version of that list β€” plain or technical β€” points at the same underlying rule:

### 🎯 *Make the smallest change that actually solves the problem β€” then verify it.*

flowchart TD
    A["πŸ§‘ You: describe what you want, in plain English"] --> B["πŸ”Ž Alphacode reads your project"]
    B --> C["πŸ—ΊοΈ It plans the steps"]
    C --> D["πŸ€– It picks the best AI model for the job"]
    D --> E["πŸ› οΈ It uses tools: edit files, run commands, search the web"]
    E --> F["βœ… It tests and reviews its own work"]
    F --> G["πŸ“‹ It reports: what changed Β· what was verified Β· what's left"]

    style A fill:#6E56CF,color:#fff,stroke:none
    style G fill:#2CBB5D,color:#fff,stroke:none


⭐ Why people choose Alphacode

🧠 Works with any AI Claude, GPT, Gemini, Copilot, Cursor, OpenRouter, Bedrock, Azure, or any OpenAI-compatible service β€” plus a free built-in AI (GMI Cloud) so it works immediately with zero setup and zero cost to try.
🐝 Splits big jobs into a team of AI agents Large tasks get broken into smaller pieces that run at the same time instead of one at a time, then get merged back together automatically.
πŸ’» A genuinely pleasant interface Full color, syntax highlighting, image previews, diagrams β€” this is not a plain black-and-white command line from the 1990s.
🧰 40+ built-in tools File editing, web search, browser control, memory, scheduling, diagram rendering, and more β€” all available without installing anything extra.
πŸ’Ύ Never lose your work Close your laptop, lose your connection, or crash your terminal β€” your session picks up right where it left off.
πŸ›‘οΈ Safety built in, not bolted on Alphacode asks before doing anything risky and refuses to run commands that could destroy your files or system.
⚑ Fast and lightweight Built in Rust β€” starts instantly and uses a fraction of the memory of comparable tools. See real numbers in Performance.


πŸ“‘ Table of Contents

πŸš€ Getting Started

🧩 What It Can Do

πŸ“š Reference


πŸ“₯ Install Alphacode

Pick your operating system below. Each installer downloads Alphacode, checks that the download is safe and untampered (a security step called checksum verification), and sets it up automatically.

Windows

  1. Open PowerShell (see how to open a terminal if you're not sure how).
  2. Copy this line, paste it in, and press Enter:
iwr -useb https://raw.githubusercontent.com/dragonked2/alphacode/main/scripts/install.ps1 | iex

πŸ” What does this actually do to my computer?

In plain English: it detects your computer's type, downloads the correct Alphacode program from GitHub's official servers, double-checks the download isn't corrupted or tampered with, and puts it in a folder on your computer where it can be launched by typing alphacode. It does not touch your other files, install background services, or need administrator access.

Technical detail: detects architecture (x86_64/arm64) β†’ resolves the latest release tag β†’ downloads alphacode-windows-{arch}.zip and SHA256SUMS β†’ verifies the SHA-256 checksum β†’ extracts alphacode.exe into %LOCALAPPDATA%\Programs\alphacode\bin\ β†’ prompts you to add that folder to your PATH (one-time, guided).

Optional: pin a specific version or install location

# Pin a version
iwr -useb ... | iex -Version v1.0.7

# Install into a custom folder
iwr -useb ... | iex -Prefix "$env:LOCALAPPDATA\Programs\alphacode"

# Build from source instead of downloading
iwr -useb ... | iex -FromSource

macOS / Linux

  1. Open Terminal.
  2. Copy this line, paste it in, and press Enter:
curl -fsSL https://raw.githubusercontent.com/dragonked2/alphacode/main/scripts/install.sh | bash

πŸ” What does this actually do to my computer?

Same idea as above, in plain English: downloads the right version for your Mac or Linux machine, verifies it's authentic, and puts the alphacode command somewhere your terminal can find it.

Technical detail: detects OS (linux/macos) and architecture β†’ resolves the latest release tag from the GitHub API β†’ downloads alphacode-{os}-{arch}.tar.gz and SHA256SUMS β†’ verifies SHA-256 β†’ extracts the binary into ~/.local/bin/ (or $ALPHACODE_PREFIX/bin) β†’ prints a PATH hint if needed.

Optional settings (environment variables):

VariableDefaultWhat it changes
`ALPHACODE_PREFIX``~/.local`Where it gets installed
`ALPHACODE_BIN_DIR``$PREFIX/bin`Exact folder for the program file
`ALPHACODE_VERSION``latest`Lock to one version, e.g. `v1.0.7`
`ALPHACODE_REPO``dragonked2/alphacode`Install from a fork/mirror
`ALPHACODE_FROM_SOURCE=1`offBuild it yourself instead of downloading
`ALPHACODE_SOURCE_ONLY=1`offNever fall back to a source build
`ALPHACODE_SOURCE_REF=<ref>`HEADWhich branch/tag/commit to build
curl -fsSL https://raw.githubusercontent.com/dragonked2/alphacode/main/scripts/install.sh | bash -s -- --version v1.0.7 --prefix ~/.local

Build from source (advanced)

Only needed if you want to compile it yourself or there's no ready-made download for your exact machine type.

git clone https://github.com/dragonked2/alphacode.git
cd alphacode
cargo build --release
./target/release/alphacode --version

Requirements

  • Rust 1.91+ (edition 2024). The repo pins this in rust-toolchain.toml, so rustup installs the right version automatically.
  • A C toolchain:
  • Linux: build-essential + pkg-config + libssl-dev (Ubuntu/Debian) or equivalent
  • macOS: Xcode Command Line Tools (xcode-select --install)
  • Windows: MSVC Build Tools + Windows SDK
  • git

A clean build takes 5–30 minutes. Rebuilds after that take seconds.

Optional feature stacks (only if you need them)

cargo build --release --features bedrock            # AWS Bedrock support
cargo build --release --features embeddings          # Local ONNX embeddings
cargo build --release --features pdf                 # PDF text extraction
cargo build --release --features mermaid-renderer     # Mermaid diagram rendering
cargo build --release --features bedrock,embeddings,pdf,mermaid-renderer  # all of the above

βœ… Verify your install

Run these three, in order, to confirm everything worked:

# 1 β€” Can your computer find it?
which alphacode          # macOS / Linux
Get-Command alphacode    # PowerShell

# 2 β€” Is it the version you expect?
alphacode --version      # β†’ v1.0.7 (964e49e, …)

# 3 β€” Is everything healthy?
alphacode doctor         # checks PATH, terminal, providers, optional dependencies

alphacode doctor prints OK, WARN, or FAIL for each check, with a fix for anything not green. If something fails, jump to Troubleshooting.

πŸ” Paranoid mode: manually verify the download's checksum

# macOS / Linux
curl -fsSL https://github.com/dragonked2/alphacode/releases/download/v1.0.7/SHA256SUMS -o SHA256SUMS
curl -fsSL https://github.com/dragonked2/alphacode/releases/download/v1.0.7/alphacode-linux-x86_64.tar.gz -o alphacode.tar.gz
sha256sum --ignore-missing -c SHA256SUMS
# Windows (PowerShell)
Invoke-WebRequest https://github.com/dragonked2/alphacode/releases/download/v1.0.7/SHA256SUMS -OutFile SHA256SUMS
$expected = (Get-Content SHA256SUMS | Where-Object { $_ -like '*windows-x86_64*' })[0].Split(' ')[0]
$actual   = (Get-FileHash .\alphacode-windows-x86_64.zip -Algorithm SHA256).Hash.ToLower()
"$expected  expected"
"$actual    actual"


⚑ Quick Start: your first 5 minutes

You don't need an account to launch Alphacode β€” but you need at least one AI "brain" connected so it can actually think. Pick the easiest option:

OptionBest forHow
πŸ†“ C Β· Just launch it Trying it out right now, zero setup

alphacode

Uses the free built-in GMI Cloud AI automatically.

πŸ”‘ A Β· Sign in Using your existing Claude/OpenAI/Gemini account

alphacode login
alphacode login --provider openai

βš™οΈ B Β· API key Developers, CI pipelines, scripts

export ALPHACODE_OPENAI_API_KEY=sk-...
alphacode

**πŸ’‘ Beginner tip:** if you're not sure which to pick, just run `alphacode` with no arguments. It works immediately using the free built-in AI β€” you can always switch providers later with `alphacode login`.

Launch it

alphacode

The first time, it'll ask a few quick setup questions (telemetry, default model, keyboard shortcuts). You can press Esc to skip any of them β€” nothing is required upfront.

Try your first task

Just describe what you want in plain sentences β€” no special syntax needed:

> explain what this project does in simple terms

> add a login button to my homepage

> find and fix the bug that's crashing the app

> write tests for my utils.js file

> look up the latest React release notes and summarize them

> /swarm "split this feature into 4 parallel tasks"

Handy keyboard shortcuts:

KeyWhat it does
`F1`Show every keyboard shortcut
`Ctrl+T`Switch AI models
`Ctrl+Y`See what each AI agent is doing
`Ctrl+C`Pause the current response (your session is kept)
`Esc`Go back / close the current dialog

🩺 Troubleshooting β€” fixing common errors

Every issue below has a copy-paste fix. Find the message closest to what you're seeing.

❌ "command not found: alphacode" (macOS / Linux)

What this means in plain English: Alphacode installed correctly, but your terminal doesn't know where to find it yet. This is normal and takes 10 seconds to fix.

# Bash β€” append to ~/.bashrc
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc

# Zsh β€” append to ~/.zshrc
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc
source ~/.zshrc

# Fish
fish_add_path ~/.local/bin

Then close and reopen your terminal.

❌ PowerShell can't find "alphacode.exe" (Windows)

What this means: same idea as above β€” Windows needs to be told where the program lives.

  1. Press Win, type "Edit the system environment variables", press Enter.
  2. Click Environment Variables… β†’ under User variables, select Path β†’ Edit… β†’ New.
  3. Paste: %LOCALAPPDATA%\Programs\alphacode\bin β†’ OK β†’ OK.
  4. Open a brand new PowerShell window (old windows won't pick up the change).

⏳ It's stuck on "Compiling alphacode (this can take 5-30 minutes)"

What this means: there's no ready-made download for your exact computer type, so it's building Alphacode from scratch on your machine. This is normal, just slow. To avoid it next time:

curl -fsSL ... | ALPHACODE_VERSION=v1.0.7 bash

πŸ¦€ "rustc … is too old; need >= 1.91"

Only relevant if you're building from source.

rustup update stable         # macOS / Linux
# Windows: re-run rustup-init from https://rustup.rs and choose "stable"

πŸ” "Checksum verification failed"

What this means: the safety check caught a corrupted or tampered download and refused to install it β€” this is the security system working as intended, not a bug. Just try the install command again. If it keeps happening, file an issue with the exact error text.

🌐 "alphacode login" opens a browser and then nothing happens

What this means: your firewall or VPN is blocking the sign-in page from talking back to Alphacode.

  • Temporarily turn off your VPN or firewall.
  • On Linux: sudo ufw allow from 127.0.0.1
  • Or skip sign-in entirely and use an API key: export ALPHACODE_OPENAI_API_KEY=sk-…

🎨 "alphacode doctor" says the terminal isn't 256-color

What this means: your terminal app is too old to show colors and icons properly.

  • βœ… Use instead: Windows Terminal, iTerm2, gnome-terminal, kitty, or WezTerm.
  • ❌ Avoid: cmd.exe or the old Windows Console Host.
  • Connecting over SSH? Add -o RequestTTY=force to your SSH command.

πŸ”€ The screen flickers or shows broken symbols/squares

What this means: your terminal's font doesn't include the icon characters Alphacode uses. Install a "Nerd Font" β€” JetBrains Mono Nerd Font or Cascadia Code Nerd Font are good picks β€” and set it as your terminal's font.

🐒 The very first response feels slow

What this means: the first message of a session does some one-time setup work behind the scenes. Every message after that is fast. If it stays slow, run alphacode doctor to pinpoint why.

Still stuck? Run alphacode doctor --verbose and paste the output when you file an issue. Found a security problem instead? Please report it privately via SECURITY.md rather than a public issue.


🧩 What can Alphacode actually do?

πŸ€– Supported AI models & providers

Alphacode doesn't lock you into one AI company. Use whichever model is best (or cheapest, or fastest) for the task at hand β€” and switch anytime.

ProviderHow you sign inGood to know
🟣 **Anthropic / Claude**Sign-in or API keyFirst-class support
🟒 **OpenAI / GPT**Sign-in, API key, or browserStrong reasoning, vision, tool use
πŸ”΅ **Google Gemini**Sign-in or API keyFull Gemini lineup
⚫ **GitHub Copilot**Sign-inReuses your existing Copilot subscription
βšͺ **Cursor**Sign-inReuses your existing Cursor session
🟠 **AWS Bedrock**AWS credentialsOptional `bedrock` build feature
πŸ”· **Azure**Azure AD or API keyOptional `azure-auth` build feature
🟑 **OpenRouter**API keyAccess to many models via one key
βš™οΈ **Any OpenAI-compatible service**API keyAdd it with `alphacode provider add`
πŸ†“ **GMI Cloud***Nothing β€” it's built in*Free, works out of the box, zero setup

Switch providers anytime, mid-conversation:

alphacode provider list              # see everything you've connected
alphacode provider current           # what's active right now
alphacode provider use openai        # make OpenAI your default
alphacode model list                 # list models for the current provider
alphacode model use gpt-4o           # pin a specific model

Or press Ctrl+T inside the app for a visual picker.

πŸ›  The full toolbox

  • πŸ“ Editing β€” read, write, patch, multi-file edits
  • πŸ” Search β€” regex, fuzzy, and AST-aware code search
  • βš™οΈ Execution β€” runs shell commands, with safety controls
  • 🌐 Web β€” fetches pages and searches the internet
  • πŸ–₯️ Browser control β€” automates a real Chrome browser

  • 🧠 Memory β€” remembers project and conversation context
  • πŸŽ“ Skills β€” reusable, pluggable capabilities
  • πŸ’Ύ Sessions β€” save, recover, and resume anytime
  • ⏰ Scheduling β€” set up recurring or background tasks
  • 🎨 Rendering β€” generates images and diagrams

Also included: PDF text extraction (optional), secure sign-in flows for every supported AI provider, and autonomous modules β€” a planner, project analyzer, self-review system, quality gate, and resource monitor working behind the scenes.

πŸŽ“ Built-in skills

"Skills" are ready-made expert playbooks Alphacode can follow. These ship inside the program itself, so they work everywhere, instantly:

SkillWhat it's for
`/bugbounty`A complete security-testing methodology β€” recon, common vulnerability classes, reporting
`/meme-coin-audit`Checks crypto tokens for rug-pull and scam risk patterns
`/frontend-design`Helps make UI work look distinctive and intentional, not generic

Type /skills inside the app to browse everything available, including any custom skills you've added yourself.

🐝 Swarm Mode: multiple AI agents working together

In plain English: instead of one AI doing everything step-by-step, Swarm Mode splits a big task into smaller independent pieces, hands each piece to its own AI agent, and has them all work at the same time β€” like assigning different parts of a group project to different teammates, then combining everyone's work at the end.

flowchart LR
    G["🎯 Your goal"] --> P["🧭 Planner splits it up"]
    P --> A["πŸ€– Agent A"]
    P --> B["πŸ€– Agent B"]
    P --> C["πŸ€– Agent C"]
    P --> D["πŸ€– Agent D"]
    A --> M["πŸ”€ Combine everything"]
    B --> M
    C --> M
    D --> M
    M --> R["βœ… Review the result"]
    R --> X["🏁 Done"]

    style G fill:#6E56CF,color:#fff,stroke:none
    style X fill:#2CBB5D,color:#fff,stroke:none

Try it:

/swarm "split this feature into 4 parallel tasks"

You can watch the whole plan and progress live inside the app.

πŸ›‘ Safety β€” how Alphacode protects your computer

AI agents that can run real commands are powerful β€” and that power needs real guardrails. Alphacode treats safety as a first-class engineering problem, not an afterthought:

  • Catastrophic targets such as rm -rf /, home-directory wipes, and device-node writes are blocked.
  • Routine authorized security tooling (nmap, subfinder, nuclei, httpx, ffuf, gobuster, curl against an in-scope target) runs without a reflection prompt.
  • Risky actions pass through the TUI permission layer.
  • Network operations use SSRF and credential-leak heuristics only where they would actually prevent abuse; authorized testing against a target that requires your own Authorization header is supported.
  • Interrupted or crashed sessions are marked instead of silently corrupting state.

Found a security vulnerability? Please report it responsibly via SECURITY.md.

πŸ” Reliability β€” never lose your work

  • alphacode --resume reopens exactly where you left off.
  • alphacode sessions list shows and searches every past session.
  • Crashes, dropped connections, and interruptions are clearly marked, never silently swallowed.
  • Everything is saved to disk in your operating system's standard, expected location.
  • Built-in health monitoring watches memory use, slow operations, and error rates during long sessions.

πŸ“Š Performance numbers

Built in Rust for a reason: speed and a small memory footprint, especially when you're running several AI sessions at once.

What makes it fast

  • Compiler optimizations (opt-level = 3, thin LTO) tuned specifically for the release build.
  • The performance-critical networking and interface code gets extra-focused compilation (codegen-units = 1).
  • Efficient reuse of network connections instead of opening new ones repeatedly.
  • Session history is stored on disk, not held entirely in memory.
  • Heavy optional features are off by default, so you only pay for what you use.
  • No embedded scripting language slowing things down β€” it's native, compiled Rust throughout.

Memory usage β€” historical snapshots

⚠️ **Important:** These are **legacy benchmark snapshots**, kept for historical comparison. Alphacode has improved further since these were measured β€” treat these as a directional illustration of architecture, not a live, current benchmark.

πŸ“ˆ RAM usage β€” 1 active session

ToolMemory usedvs. Alphacode's most efficient mode
πŸ₯‡ **Alphacode β€” local embedding off****27.8 MB****1.0Γ—**
Alphacode (default)167.1 MB6.0Γ—
pi144.4 MB5.2Γ—
Codex CLI140.0 MB5.0Γ—
Cursor Agent214.9 MB7.7Γ—
Antigravity CLI243.7 MB8.8Γ—
GitHub Copilot CLI333.3 MB12.0Γ—
Claude Code386.6 MB13.9Γ—
OpenCode371.5 MB13.4Γ—

πŸ“ˆ RAM usage β€” 10 active sessions at once

This is where architecture really matters β€” running several AI sessions in parallel is common for real engineering work.

ToolMemory usedvs. Alphacode's most efficient mode
πŸ₯‡ **Alphacode β€” local embedding off****117.0 MB****1.0Γ—**
Alphacode (default)260.8 MB2.2Γ—
Codex CLI334.8 MB2.9Γ—
pi833.0 MB7.1Γ—
Antigravity CLI1021.2 MB8.7Γ—
Cursor Agent1632.4 MB14.0Γ—
GitHub Copilot CLI1756.5 MB15.0Γ—
Claude Code2300.6 MB19.7Γ—
OpenCode3237.2 MB27.7Γ—

In plain English: a tool can look fine using one session, but memory costs multiply fast with real usage. Alphacode was designed from the start to stay lean even with many sessions running side by side.

πŸ“ Benchmark methodology (for anyone who wants to reproduce or challenge these numbers)

Alphacode doesn't treat a single README number as proof of universal performance. Any future benchmark report should state:

  1. Alphacode commit/version tested
  2. OS and hardware
  3. Build profile used
  4. Which optional features were enabled
  5. Number of active sessions
  6. Exact measurement method
  7. Warm vs. cold state
  8. The exact workload/task used

That's what makes a performance claim reproducible instead of just promotional.


πŸ“œ Code quality guarantees

Every code-changing action Alphacode takes follows four rules:

1️⃣ Smallest change

Only touches what's needed for the task. Unrelated issues get reported separately, never silently bundled in.

2️⃣ No regressions

Tests that were passing stay passing. New warnings count as failures where it matters.

3️⃣ Self-review

Before calling anything "done," it checks its own coverage, evidence, risk, and edge cases.

4️⃣ Clear reporting

Every finished task ends with: what changed Β· what was verified Β· what's left.

The source of truth lives in src/alphacode_base/prompt/system_prompt.md, enforced by the tool implementations under src/alphacode_app_core/tool/.


⌨️ Commands reference

CLI commands

alphacode                          # Launch the app
alphacode login                    # Sign in to an AI provider
alphacode login --provider openai  # Sign in to a specific provider
alphacode doctor                   # Check that everything's set up correctly
alphacode doctor --verbose         # Same, with extra detail for bug reports
alphacode provider list            # List every provider you've connected
alphacode provider add <name>      # Add a custom OpenAI-compatible endpoint
alphacode provider use <name>      # Set your default provider
alphacode provider current         # Show the active provider + model
alphacode model list               # List available models
alphacode model use <name>         # Set your default model
alphacode run "fix the failing test"   # Run one task without opening the full app
alphacode repl                     # A simple text-only mode
alphacode sessions list            # See your past sessions
alphacode --resume                 # Search for and reopen a session
alphacode --resume <id>            # Reopen one specific session
alphacode update                   # Update to the latest version
alphacode --version                # Check your current version
alphacode --help                   # See every available command

In-app slash commands

CommandWhat it does
`/help`Show every command
`/agents`Start multiple AI agents working in parallel
`/compact`Shrink a long conversation to save space
`/memory`View what Alphacode remembers about your project
`/skills`Browse and manage available skills
`/diff`See exactly what changed, file by file
`/exit`Close the app (your session is saved automatically)

βš™οΈ Configuration

Alphacode keeps its settings, sessions, and logs in your operating system's standard location β€” never scattered inside your project folder.

PlatformSettingsSessionsLogs
🐧 Linux`~/.config/alphacode/``~/.local/share/alphacode/sessions/``~/.local/share/alphacode/logs/`
🍎 macOS`~/Library/Application Support/alphacode/`*same**same*
πŸͺŸ Windows`%APPDATA%\alphacode\``%LOCALAPPDATA%\alphacode\sessions\``%LOCALAPPDATA%\alphacode\logs\`

The main settings file, config.toml, is created automatically the first time you run alphacode login. Full reference: docs/configuration.md.


πŸ”„ Updating Alphacode

alphacode update

This grabs the newest version, verifies it's safe, and swaps it in β€” without interrupting anything you have running. You can also just re-run the original install command any time; it's safe to run repeatedly.


πŸ—‘ Uninstalling Alphacode

macOS / Linux

curl -fsSL https://raw.githubusercontent.com/dragonked2/alphacode/main/scripts/uninstall.sh | bash

Want to remove your settings, sessions, and logs too?

curl -fsSL https://raw.githubusercontent.com/dragonked2/alphacode/main/scripts/uninstall.sh | bash -s -- --purge

Windows

iwr -useb https://raw.githubusercontent.com/dragonked2/alphacode/main/scripts/uninstall.ps1 | iex

Add -Purge to also remove settings, sessions, and logs.


πŸ— Project structure

For contributors and the technically curious β€” here's how the codebase is organized:

alphacode/
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ alphacode_core/             # Provider-agnostic trait types and shared state
β”‚   β”œβ”€β”€ alphacode_base/             # System prompt, prompt builder, capability enum
β”‚   β”œβ”€β”€ alphacode_app_core/         # Agent loop, tools, autonomous layer, server
β”‚   β”œβ”€β”€ alphacode_tui*/             # Terminal UI: rendering, widgets, style, animations
β”‚   β”œβ”€β”€ alphacode_tool_core/        # The `Tool` trait and shared tool types
β”‚   β”œβ”€β”€ alphacode_provider_*/       # Per-provider runtimes (Anthropic, OpenAI, …)
β”‚   β”œβ”€β”€ alphacode_auth_*/           # Per-provider OAuth flows
β”‚   β”œβ”€β”€ alphacode_swarm_core/       # Multi-agent coordination (task DAG, deep/light modes)
β”‚   β”œβ”€β”€ alphacode_modules/          # High-level autonomous modules
β”‚   └── alphacode_cli/              # The `alphacode` binary entrypoint
β”œβ”€β”€ docs/                           # Architecture + configuration reference
β”œβ”€β”€ scripts/                        # install / uninstall tooling
β”œβ”€β”€ CONTRIBUTING.md
β”œβ”€β”€ SECURITY.md
└── Cargo.toml

Deeper tour: docs/architecture.md.


🀝 Contributing

Contributions are genuinely welcome, from typo fixes to new features. Full guide: CONTRIBUTING.md. Short version:

git clone https://github.com/dragonked2/alphacode.git
cd alphacode
cargo build --release
cargo test --lib
cargo clippy --lib -- -D warnings

Requirements: Rust 1.91+ (edition 2024) and a matching C toolchain.

Before opening a pull request:

  • [ ] cargo build --release passes locally
  • [ ] cargo test --lib passes locally (add tests for behavior changes)
  • [ ] cargo clippy --lib -- -D warnings is clean
  • [ ] Public APIs have rustdoc comments
  • [ ] No new dependencies unless justified in the PR description
  • [ ] User-visible changes are documented in CHANGELOG.md

Security vulnerabilities: SECURITY.md. Community standards: CODE_OF_CONDUCT.md.


❓ Frequently Asked Questions

Do I need to know how to code to use Alphacode?

No. You need to be comfortable copy-pasting a command into a terminal and describing what you want in plain English. Alphacode handles the actual coding. See I'm brand new β€” start here.

Is Alphacode free?

Yes β€” Alphacode itself is free and open source under the MIT License. It includes a free built-in AI (GMI Cloud) so you can use it with zero cost and zero setup. If you connect a paid AI provider (like a Claude or OpenAI account) instead, that provider's own usage costs apply β€” Alphacode doesn't add any fee on top.

Which AI model does Alphacode use β€” Claude, GPT, or Gemini?

Whichever you choose. Alphacode isn't tied to one AI company β€” see Supported AI models & providers for the full list, and switch anytime with Ctrl+T.

Is it safe to let an AI run commands on my computer?

Alphacode is built with safety as a core design principle, not an add-on: it blocks catastrophic commands outright, asks for confirmation before anything risky, and never sends your code anywhere by default. See Safety for the full picture. As with any tool that can modify files, it's good practice to review changes (/diff) and use version control (git).

How is this different from GitHub Copilot, Cursor, or Claude Code?

The biggest differences: Alphacode works with any AI provider instead of locking you to one, runs natively in the terminal instead of requiring an IDE, supports running multiple AI agents in parallel ("Swarm Mode"), and is built in Rust for a notably smaller memory footprint β€” see Performance numbers for a direct comparison.

Does it work on Windows?

Yes β€” Windows, macOS, and Linux are all fully supported. See Install Alphacode.

What if the install command doesn't work?

Check Troubleshooting β€” it covers every common install and first-run issue with a copy-paste fix.

Can I use my own OpenAI or Claude subscription instead of the free built-in AI?

Yes. Run alphacode login and pick your provider, or set an API key as an environment variable. Full steps in Quick Start.


πŸ™ Acknowledgements

Alphacode is built on outstanding open-source projects, including:

![Ratatui](https://ratatui.rs) ![Crossterm](https://github.com/crossterm-rs/crossterm) ![Tokio](https://tokio.rs) ![Reqwest](https://github.com/seanmonstar/reqwest) ![Rustls](https://github.com/rustls/rustls) ![Clap](https://github.com/clap-rs/clap) ![Pulldown--CMark](https://github.com/raphlinus/pulldown-cmark) ![Syntect](https://github.com/trishume/syntect) ![Resvg](https://github.com/RazrFalcon/resvg)

...and many others β€” see Cargo.lock for the complete dependency graph.


πŸ“„ License

Alphacode is released under the MIT License β€” free to use, modify, and distribute. Full text: LICENSE.


Alphacode
The AI coding agent for your terminal Β· Built with Rust πŸ¦€ Β· Free & open source



GitHub Β· Issues Β· Releases Β· Documentation



Made with care by Ali Essam Β· MIT licensed