Start

Install

Install

gog ships as a single binary. The visible version is injected at build time: release builds use the tag, while local builds use git describe.

#Homebrew (macOS, Linux)

brew install gogcli
gog --version

The Homebrew formula lives in steipete/homebrew-tap and installs the gog binary. Release verification should run:

brew test steipete/tap/gogcli
gog --version

#Docker / GHCR

Release tags publish a non-root GitHub Container Registry image:

docker run --rm ghcr.io/steipete/gogcli:latest version
docker run --rm ghcr.io/steipete/gogcli:v0.15.0 version

Authenticated container runs should mount a persistent config directory and use the encrypted file keyring:

docker volume create gogcli-config

docker run --rm -it \
  -e GOG_KEYRING_BACKEND=file \
  -e GOG_KEYRING_PASSWORD \
  -v gogcli-config:/home/gog/.config/gogcli \
  ghcr.io/steipete/gogcli:latest \
  auth add you@gmail.com --services gmail,calendar,drive

Keep GOG_KEYRING_PASSWORD in the shell session or your CI secret store. Do not bake it into images, scripts, or checked-in profiles.

#Windows

Download the matching ZIP from the latest release:

  • gogcli_<version>_windows_amd64.zip
  • gogcli_<version>_windows_arm64.zip

Extract gog.exe and put its directory on PATH.

#GitHub releases (raw binaries)

Release assets are uploaded by GoReleaser:

  • gogcli_<version>_darwin_amd64.tar.gz
  • gogcli_<version>_darwin_arm64.tar.gz
  • gogcli_<version>_linux_amd64.tar.gz
  • gogcli_<version>_linux_arm64.tar.gz
  • gogcli_<version>_windows_amd64.zip
  • gogcli_<version>_windows_arm64.zip
  • checksums.txt

Browse the releases page for the latest tag and the full asset list.

#Build from source

git clone https://github.com/steipete/gogcli.git
cd gogcli
make
./bin/gog --version

Source builds require the Go version declared in go.mod.

#Safety-profile binaries

When gog is going to be invoked by an agent, sandbox, or other caller that should not be able to broaden its own permissions, build a safety-profile binary instead of the default one. See Safety Profiles.

./build-safe.sh safety-profiles/agent-safe.yaml -o bin/gog-agent-safe
./build-safe.sh safety-profiles/readonly.yaml   -o bin/gog-readonly

#Verify the install

gog --version
gog auth keyring         # report current keyring backend
gog --help               # discover top-level commands

After running gog auth credentials and gog auth add, gog auth doctor --check reports keyring health, refresh-token validity, and Workspace-specific failure modes.

#Updating

  • Homebrew: brew upgrade gogcli.
  • Docker: pull a new tag (ghcr.io/steipete/gogcli:vX.Y.Z).
  • GitHub release archives: download the new tarball/ZIP and replace the
  • binary.

  • Source builds: git pull && make — the version string comes from
  • git describe.

Refresh tokens and OAuth clients are forward-compatible across point releases; no migration step is required for normal upgrades.