ggcode

README

ggcode

English | 中文

An AI coding agent for the terminal. Understands your codebase, edits files, runs commands, and ships code — with a polished TUI, resumable sessions, and multi-agent support.

---

Install

macOS / Linux:

curl -fsSL https://ggcode.dev/install.sh | bash

Windows:

irm https://ggcode.dev/install.ps1 | iex

Other methods: Homebrew · winget · npm · pip · build from source

All install scripts default to non-privileged (no sudo / admin required).

Quick Start

# 1. Run ggcode in your project
cd your-project
ggcode

# 2. On first launch, configure your API key (interactive prompt)
#    Or set it directly:
#    Or set up via the interactive wizard on first launch

# 3. Start coding — just type your request

New to ggcode? Read the Getting Started guide.

Features

• Codebase-aware — reads, understands, and edits your entire project
• Full dev toolkit — file edits, shell commands, Git, LSP, search
• MCP integration — connect external tools and data sources
• gRPC plugins — extend ggcode with custom tools in Go, Python, Node.js, or any language
• Multi-agent — spawn parallel workers, delegate to teammates, A2A protocol
• Editor integration — JetBrains, Zed, and ACP-compatible editors via ACP
• WebUI — built-in web interface accessible from any browser
• IM integration — control from QQ, Telegram, Discord, Slack, Feishu, DingTalk
• Harness workflow — isolated task execution with review and promotion
• Scheduled tasks — cron jobs, reminders, and background automation
• Resumable sessions — pause and resume any conversation
• Desktop + Mobile — native apps for macOS, Windows, Linux, iOS, Android

Platforms

Platform	Install
CLI (macOS/Linux/Windows)	This repo — the primary interface
Desktop	Native app for macOS, Windows, Linux
Mobile	iOS (App Store) and Android (Google Play)

Documentation

Guide	Description
Getting Started	First steps, API key setup, basic usage
Installation	All install methods for every platform
CLI Reference	Commands, flags, pipe mode
Providers	LLM vendor and endpoint configuration
Slash Commands	In-TUI command reference
Permission Modes	Supervised, plan, auto, bypass, autopilot
MCP Servers	Connect external tools via MCP
gRPC Plugins	Build and install custom tool plugins (Go, Python, Node.js)
IM Integration	QQ, Telegram, Discord, Slack, Feishu, DingTalk
Harness	Isolated task workflow with review
A2A Protocol	Cross-instance agent delegation
ACP / Editor	JetBrains, Zed, and ACP-compatible editors
Delegation	Delegate tasks to Copilot, Claude, Cursor, and other agents
Multi-Agent	Sub-agents, teammates, and team coordination
Configuration	Full config file reference
Project Memory	GGCODE.md, AGENTS.md, CLAUDE.md
Skills	Reusable workflow patterns
Shell Completion	bash, zsh, fish, powershell

Quick Links

• Download Desktop App · Releases
• Report a Bug · Request a Feature

License

MIT