Introduction to Codey

Codey is a secure, developer-focused AI coding agent. It is designed to work where you work: inside your local terminal, as a standalone desktop companion, or integrated with your favorite editors.

Unlike generic prompt-completion tools, Codey is project-aware, supports a secure local execution loop, and can coordinate specialized subagents to plan, write, and verify your code locally.

#Prerequisites

Before running Codey in your shell, ensure you have:

• A modern terminal emulator (e.g. Kitty, WezTerm, Alacritty, or Ghostty) for proper color rendering and keybinding support.
• API keys for your preferred LLM provider, or an account on Codey Zen for automatic curated routing.

#Installation

The quickest way to install Codey on Linux and macOS is via the shell script:

curl -fsSL https://codey.ai/install | bash

Alternatively, choose the appropriate package manager below:

brew install fares-moustafa/tap/codey

#Connecting & Configuring

Configure your preferred LLM provider by running the connect command in your terminal. This opens a visual selector where you can register keys:

codey auth login

Or run the terminal UI and type /connect to paste your credentials. If you are signed in with a Codey Account, your Pro subscription status and API keys will sync automatically between the CLI and the Desktop application.

#Initializing a Project

Navigate to your repository and run Codey. The first step in any new workspace is to run the init command:

codey
# Inside the TUI:
/init

This directs Codey to inspect your project structure and generate an AGENTS.md file in the root. Commit this file to your git repository to guide Codey's coding style, conventions, and file structures.