Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.grounds.gg/llms.txt

Use this file to discover all available pages before exploring further.

The grounds CLI is a single static Go binary. No JVM, no Node, no system dependencies.

​
Install

brew install --cask groundsgg/tap/grounds
Upgrade:
brew upgrade --cask groundsgg/tap/grounds

​
Verify

grounds version
grounds doctor
grounds doctor runs five checks: config, auth, api, gradle, java. The gradle and java checks are advisory — you only need them for actually pushing.

​
Shell completion

Generate completion scripts on demand: 
grounds completion bash > /etc/bash_completion.d/grounds          # bash
grounds completion zsh  > "${fpath[1]}/_grounds"                  # zsh
grounds completion fish > ~/.config/fish/completions/grounds.fish # fish

​
Updating

The CLI checks for updates lazily and prints a banner when a newer version is published. There is no auto-upgrade — use your installer of choice (brew, scoop, the install script).

​
What’s where after install

PathPurpose
~/.config/grounds/ (Linux), ~/Library/Application Support/grounds/ (macOS), %APPDATA%\grounds\ (Windows)Config + credentials
$XDG_CACHE_HOME/grounds/Resolved API metadata cache
Override with --config <dir> or GROUNDS_CONFIG_DIR.