Skip to main content

Thin Python wrapper that installs the ggcode GitHub Release binary

Project description

ggcode Python wrapper

ggcode on PyPI bootstraps the native ggcode terminal agent from GitHub Releases.

When the bootstrap runs, it installs the real binary into a stable CLI location instead of keeping it in a wrapper-managed cache:

  • macOS / Linux: prefers /usr/local/bin, falls back to ~/.local/bin
  • Windows: prefers %USERPROFILE%\\AppData\\Local\\Programs\\ggcode\\bin, falls back to %USERPROFILE%\\.local\\bin

If that directory is not already on PATH, the bootstrap updates your PATH configuration and asks you to reopen the terminal so future ggcode launches resolve directly to the native binary.

Install

pip install ggcode

Then run:

ggcode

If you ever need to rerun the bootstrap flow explicitly, you can also use:

ggcode-bootstrap

What it does

  • Detects your operating system and CPU architecture
  • Downloads the latest matching ggcode archive from GitHub Releases
  • Verifies the archive against checksums.txt
  • Installs the real binary into a stable PATH location
  • Updates PATH so future ggcode launches bypass the Python wrapper

Pin a specific ggcode release

By default, the wrapper always resolves the latest ggcode release.

To force a specific release, set GGCODE_INSTALL_VERSION:

GGCODE_INSTALL_VERSION=vX.Y.Z ggcode

or:

GGCODE_INSTALL_VERSION=X.Y.Z ggcode

Other install methods

Homebrew (macOS / Linux)

brew tap topcheer/ggcode
brew install ggcode              # CLI
brew install ggcode-desktop      # Desktop (Linux)
brew install --cask ggcode-desktop  # Desktop (macOS DMG)

winget (Windows)

winget install --id gg.ai.ggcode-cli        # CLI
winget install --id gg.ai.ggcode-desktop    # Desktop

Native release packages

Download directly from GitHub Releases:

Platform Format Install command
macOS .pkg sudo installer -pkg ./ggcode_*_darwin_universal.pkg -target /
Windows .msi msiexec /i .\ggcode_*_windows_x64.msi
Debian / Ubuntu .deb sudo dpkg -i ./ggcode_*_linux_*.deb
Fedora / RHEL .rpm sudo rpm -i ./ggcode-*-1.*.rpm
Alpine .apk sudo apk add --allow-untrusted ./ggcode-*-r1.*.apk
Arch Linux .pkg.tar.zst sudo pacman -U ./ggcode-*-1-*.pkg.tar.zst

What is ggcode?

ggcode is a terminal-native AI coding agent — not a browser wrapper, not a VS Code extension. It runs entirely in your terminal with a polished TUI:

  • Multi-provider LLM support — OpenAI, Anthropic, Google Gemini, GitHub Copilot, DeepSeek, and more
  • Five permission modes — supervised, plan, auto, bypass, autopilot — you decide how much autonomy the agent gets
  • LSP integration — go-to-definition, references, rename, diagnostics, code actions via your language server
  • MCP tools — connect external tool servers (browser, databases, APIs) seamlessly
  • Sub-agents — spawn parallel workers for research, coding, and testing tasks
  • Harness workflows — structured engineering pipelines with git worktrees, review, and promotion
  • IM gateway — connect QQ, Telegram, Discord, Slack, DingTalk, or Feishu for remote coding
  • Bilingual UI — full English and Chinese support
  • Session persistence — resume past sessions with ggcode --resume
  • File checkpoints — undo bad edits instantly without git

Supported platforms

  • macOS
  • Linux
  • Windows

Supported architectures:

  • x86_64 / amd64
  • arm64

Desktop Application

ggcode also ships as a native desktop GUI application with visual chat, IM integration, and tool approval dialogs.

Download from GitHub Releases:

Platform Asset
macOS (Universal) ggcode-desktop_*_darwin_universal.dmg
Windows ggcode-desktop_*_windows_amd64.exe

Project links

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ggcode-1.3.123.tar.gz (8.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ggcode-1.3.123-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

Details for the file ggcode-1.3.123.tar.gz.

File metadata

  • Download URL: ggcode-1.3.123.tar.gz
  • Upload date:
  • Size: 8.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for ggcode-1.3.123.tar.gz
Algorithm Hash digest
SHA256 f7db7247246f07733f520e0ef08c645cf56367c2e87b1cfd22743277642fa3c8
MD5 b8c539177d41950c4a53cddbb9c91936
BLAKE2b-256 1684133be328c55814718a55b30c707f080f7b3fdbd820782d0df338f83851f3

See more details on using hashes here.

Provenance

The following attestation bundles were made for ggcode-1.3.123.tar.gz:

Publisher: publish-pypi.yml on topcheer/ggcode

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ggcode-1.3.123-py3-none-any.whl.

File metadata

  • Download URL: ggcode-1.3.123-py3-none-any.whl
  • Upload date:
  • Size: 7.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for ggcode-1.3.123-py3-none-any.whl
Algorithm Hash digest
SHA256 519b9df209ec89e86dfa518203bb12ddb5b367dc984a135aed840f6781f37986
MD5 8ff6d3e17a3d565f434144aec8b66e4f
BLAKE2b-256 547314e9a828799acb94b85989b41b11808622d441e8ef19d3788afd7e6f68d1

See more details on using hashes here.

Provenance

The following attestation bundles were made for ggcode-1.3.123-py3-none-any.whl:

Publisher: publish-pypi.yml on topcheer/ggcode

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page