Installation

Get KOPI O Agent up and running in under two minutes with the one-line installer.

Quick Install

Linux / macOS / WSL2

curl -fsSL https://raw.githubusercontent.com/XingBaoKu/kopi-agent/main/scripts/install.sh | bash

Windows (native, PowerShell) — Early Beta

Early BETA

Native Windows support is early beta. It installs and works for the common paths, but hasn't been road-tested as broadly as our POSIX installers. Please file issues when you hit rough edges. For the most battle-tested setup on Windows today, use the Linux/macOS one-liner above inside WSL2 instead.

Open PowerShell and run:

irm https://raw.githubusercontent.com/XingBaoKu/kopi-agent/main/scripts/install.ps1 | iex

The installer handles everything: uv, Python 3.11, Node.js 22, ripgrep, ffmpeg, and a portable Git Bash (PortableGit — a self-contained Git-for-Windows distribution that ships bash.exe and the full POSIX toolchain Kopi uses for shell commands; on 32-bit Windows the installer falls back to MinGit, which lacks bash and disables terminal-tool / agent-browser features). It clones the repo under %LOCALAPPDATA%\kopi\kopi-agent, creates a virtualenv, and adds kopi to your User PATH. Restart your terminal (or open a new PowerShell window) after the install so PATH picks up.

How Git is handled:

1. If git is already on your PATH, the installer uses your existing install.
2. Otherwise it downloads portable PortableGit (~50MB, from the official git-for-windows GitHub release) and unpacks it to %LOCALAPPDATA%\kopi\git. No admin rights required. Completely isolated — it won't interfere with any system Git install, broken or otherwise. (On 32-bit Windows it falls back to MinGit because PortableGit ships only 64-bit and ARM64 assets; bash-dependent Kopi features won't work on 32-bit hosts.)

Why not use winget? Earlier designs auto-installed Git via winget install Git.Git, but winget fails badly when a system Git install is in a partial or broken state (exactly when users need the installer to just work). The portable Git approach sidesteps winget, the Windows installer registry, and any existing system Git entirely. If the Kopi Git install itself ever breaks, Remove-Item %LOCALAPPDATA%\kopi\git and re-run the installer — no system impact, no uninstall drama.

The installer also sets KOPI_GIT_BASH_PATH to the located bash.exe so Kopi resolves it deterministically in fresh shells.

If you prefer WSL2, the Linux installer above works inside it; both native and WSL installs can coexist without conflict (native data lives under %LOCALAPPDATA%\kopi, WSL data lives under ~/.kopi).

Android / Termux

Kopi now ships a Termux-aware installer path too:

curl -fsSL https://raw.githubusercontent.com/XingBaoKu/kopi-agent/main/scripts/install.sh | bash

The installer detects Termux automatically and switches to a tested Android flow:

• uses Termux pkg for system dependencies (git, python, nodejs, ripgrep, ffmpeg, build tools)
• creates the virtualenv with python -m venv
• exports ANDROID_API_LEVEL automatically for Android wheel builds
• prefers the broad .[termux-all] extra and falls back to the smaller .[termux] extra (and finally a base install) if the first attempt fails to compile
• skips the untested browser / WhatsApp bootstrap by default

If you want the fully explicit path, follow the dedicated Termux guide.

Windows Feature Parity (Early Beta)

Native Windows is in early beta. Everything except the browser-based dashboard chat terminal runs natively on Windows:

• CLI (kopi chat, kopi setup, kopi gateway, …) — native, uses your default terminal
• Gateway (Telegram, Discord, Slack, …) — native, runs as a background PowerShell process
• Cron scheduler — native
• Browser tool — native (Chromium via Node.js)
• MCP servers — native (stdio and HTTP transports both supported)
• Dashboard /chat terminal pane — WSL2 only (uses a POSIX PTY; native Windows has no equivalent). The rest of the dashboard (sessions, jobs, metrics) works natively — only the embedded PTY terminal tab is gated.

Set KOPI_DISABLE_WINDOWS_UTF8=1 in your environment if you hit an encoding-related bug and want to fall back to the legacy cp1252 stdio path (useful for bisecting).

What the Installer Does

The installer handles everything automatically — all dependencies (Python, Node.js, ripgrep, ffmpeg), the repo clone, virtual environment, global kopi command setup, and LLM provider configuration. By the end, you're ready to chat.

Install Layout

Where the installer puts things depends on whether you're installing as a normal user or as root:

Installer	Code lives at	kopi binary	Data directory
Per-user (normal)	~/.kopi/kopi-agent/	~/.local/bin/kopi (symlink)	~/.kopi/
Root-mode (sudo curl … | sudo bash)	/usr/local/lib/kopi-agent/	/usr/local/bin/kopi	/root/.kopi/ (or $KOPI_HOME)

The root-mode FHS layout (/usr/local/lib/…, /usr/local/bin/kopi) matches where other system-wide developer tools land on Linux. It's useful for shared-machine deployments where one system install should serve every user. Per-user config (auth, skills, sessions) still lives under each user's ~/.kopi/ or explicit KOPI_HOME.

After Installation

Reload your shell and start chatting:

source ~/.bashrc   # or: source ~/.zshrc
kopi             # Start chatting!

To reconfigure individual settings later, use the dedicated commands:

kopi model          # Choose your LLM provider and model
kopi tools          # Configure which tools are enabled
kopi gateway setup  # Set up messaging platforms
kopi config set     # Set individual config values
kopi setup          # Or run the full setup wizard to configure everything at once

---

Prerequisites

The only prerequisite is Git. The installer automatically handles everything else:

• uv (fast Python package manager)
• Python 3.11 (via uv, no sudo needed)
• Node.js v22 (for browser automation and WhatsApp bridge)
• ripgrep (fast file search)
• ffmpeg (audio format conversion for TTS)

信息

You do not need to install Python, Node.js, ripgrep, or ffmpeg manually. The installer detects what's missing and installs it for you. Just make sure git is available (git --version).

Nix users

If you use Nix (on NixOS, macOS, or Linux), there's a dedicated setup path with a Nix flake, declarative NixOS module, and optional container mode. See the Nix & NixOS Setup guide.

---

Manual / Developer Installation

If you want to clone the repo and install from source — for contributing, running from a specific branch, or having full control over the virtual environment — see the Development Setup section in the Contributing guide.

---

Troubleshooting

Problem	Solution
kopi: command not found	Reload your shell (source ~/.bashrc) or check PATH
API key not set	Run kopi model to configure your provider, or kopi config set OPENROUTER_API_KEY your_key
Missing config after update	Run kopi config check then kopi config migrate

For more diagnostics, run kopi doctor — it will tell you exactly what's missing and how to fix it.