Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 

README.md

GhostCode CLI

Open-source starter template for a terminal coding harness.

ghostcode-cli is the runtime package: local-first agent loop, PLAN/BUILD modes, and your API keys. Fork the full repo to customize prompts, tools, and UI.

See Build your own harness in the repo root.

Runtime requirement

ghostcode-cli currently requires Bun at runtime. Even if you install with npm install -g ghostcode-cli, the ghostcode command needs Bun installed on your machine.

Install Bun

curl -fsSL https://bun.sh/install | bash

Then restart your terminal and verify:

bun --version

Install

npm install -g ghostcode-cli

or

bun install -g ghostcode-cli

Run

From your project directory:

ghostcode

Quick usage

# Open the harness TUI
ghostcode

# Set provider keys (one or both)
export ANTHROPIC_API_KEY=sk-ant-...
export OPENAI_API_KEY=sk-proj-...

Inside the harness:

  • tab — toggle PLAN/BUILD mode
  • /models — switch model
  • /theme — switch UI profile
  • /sessions — resume previous chats

Screenshots

Launch

GhostCode launch screen

Session

GhostCode session view

Theme Picker

GhostCode theme picker

Command Palette

GhostCode command palette

Environment variables

  • ANTHROPIC_API_KEY — Claude models
  • OPENAI_API_KEY — GPT models
  • GHOSTCODE_CONFIG_DIR — override default config path (~/.ghostcode)

Harness highlights

  • Full-screen terminal UI
  • PLAN/BUILD modes
  • Local file + shell tools
  • Session persistence per project
  • Project memory via Ghost.md

For full product docs, architecture, and contributor setup, see the repository root README.md.