Documentation Navigation
usage

Command Line Interface Reference

Codey provides a set of CLI commands to run agents programmatically, start the local server, manage authentication, and handle custom configurations.

#General Usage

bash
codey [command] [options]

#Core Commands

#1. codey run

Runs a single prompt non-interactively from the shell. Ideal for automation and scripts.

bash
codey run "Refactor the authentication logic in src/auth.ts"

#2. codey serve

Starts the local HTTP API and WebSocket server. This allows editors and the Desktop client to communicate with Codey CLI on your machine.

bash
codey serve --port 4096 --hostname 127.0.0.1

#3. codey web

Starts the local server and opens the web client in your default web browser.

bash
codey web

#4. codey auth

Manages login, logout, credentials sync, and subscription status.

bash
codey auth login --account
codey auth status

#5. codey agent create

Runs an interactive prompt builder to define and save a custom agent configuration.

bash
codey agent create