docs

From install to a working session.

Covexcode is a coding agent for the terminal and the editor. This page is the user guide: install, sign in, features, CLI, IDE, and config.

01

Quick start

  1. 1. Install the IDE

    The editor ships with its agent runtime inside — no separate CLI install is required. Download the build for your OS.

  2. 2. Sign in

    Promo credits live on llm.covexcode.com. Sign in from the IDE account menu, or from a terminal:

    covexcode login

    Credentials are written to ~/.covexcode/config.toml. The IDE and CLI use the same account.

  3. 3. Run it in a project

    Open a folder in the IDE and send a message in chat, or start from a terminal:

    cd your-project
    covexcode

    Type a sentence and press Enter. Destructive actions wait for y/n.

  4. 4. Optional — terminal CLI

    Install the CLI only if you also want covexcode from a shell. Checksum-verified binary — no Rust toolchain.

    curl -fsSL https://covexcode.com/install.sh | bash

    Already installed? covexcode --upgrade

02

Sign in path

Login is Google-only. It links this machine to your covexcode.com account and mints a promo key on llm.covexcode.com. Skip it if you already have your own API key — use /provider instead.

  1. 01

    Start from CLI or IDE

    covexcode login, /login inside the TUI, or Sign in in the IDE.

  2. 02

    Google on covexcode.com

    If this browser is not signed in, you go through Google.

  3. 03

    Authorize

    The device page asks Covexcode to connect to your account. Click Authorize.

  4. 04

    Config is written

    ~/.covexcode/config.toml gets endpoint, model, and key. Both CLI and IDE use this.

Site sign-in: Sign in.

03

What Covexcode does

  • Reads, writes, and runs

    Destructive actions wait for y/n. Catastrophic commands are never offered.

  • Every file change is a diff

    Approve red and green lines against the file on disk.

  • /plan, then write

    Research first. Approve the approach before any file changes.

  • Open endpoints

    Any OpenAI-compatible LLM via /provider or env vars.

04

CLI

A native Rust TUI on macOS, Linux, and Windows.

Slash commands

  • /planResearch first, then approve a plan before any file changes
  • /providerPick a provider, then a model
  • /modelRe-pick the model for the current provider
  • /loginSign in with Google in the browser, or show status if already linked
  • /logoutClear the local covexcode.com session and promo key
  • /initExplore the project and write COVEXCODE.md
  • /resumeReload this directory's last session
  • /pullSwitch to a different project this machine has published
  • /newStart a fresh conversation (the old one stays on disk for /resume)
  • /compactSummarize a long conversation, freeing context
  • /usageLocal token usage — today, last 7 days, all time
  • /quotaWhat is left today, and any limits you set
  • /rollbackUndo every file the model wrote this session
  • /diffShow everything changed on disk this session
  • /hostedProjects this machine is hosting, and whether they are live
  • /exitLeave covexcode

05

IDE

Covexcode IDE is a Code-OSS fork with a pinned agent runtime bundled inside. Chat talks to that runtime over ACP — no separate CLI install and no second agent in TypeScript.

macOS builds are Developer ID signed and notarized. Open the DMG, drag Covexcode IDE into Applications, and launch it; if Gatekeeper still asks, use right-click → Open.

06

Config

Everything lives under ~/.covexcode/. Env vars override the file.

# ~/.covexcode/config.toml

[tools]
enabled = true
workspace = "."
approval = "destructive"   # or "always"

[ui]
theme = "auto"             # auto | dark | light

Point it at your own endpoint without login:

export COVEXCODE_ENDPOINT=https://api.deepseek.com
export COVEXCODE_MODEL=deepseek-v4-flash
export COVEXCODE_API_KEY=…

07

Account and credits

A new Google account on covexcode.com gets a lifetime promo credit on llm.covexcode.com. Prefer your own provider? Skip login and run /provider.

Open your account dashboard.

08

Manuals

Download the installation manuals for offline reference.

09

Reference