← Back to Guides

How to Install GOG on Windows (04/12/26)

This guide shows the recommended way to install gog (the Google Workspace CLI from steipete/gogcli) on Windows, verify your PATH, complete first auth, and run a successful test command.

What GOG is

gog is a script-friendly CLI for Google services like Gmail, Calendar, Drive, Docs, Sheets, Contacts, and Tasks. It supports multiple accounts, JSON output, and OAuth/service-account auth modes.

Prerequisites

• Windows 10/11 (PowerShell recommended).
• A Google account (or Workspace account).
• Google Cloud project + OAuth Desktop Client JSON (client_secret_*.json).
• Internet access to GitHub Releases and Google OAuth endpoints.

Install method 1 (recommended): GitHub release binary

1. Open the releases page:
   https://github.com/steipete/gogcli/releases
2. Download the current Windows archive for your CPU:
   • gogcli_*_windows_amd64.zip (most PCs)
   • gogcli_*_windows_arm64.zip (ARM PCs)
3. Extract it, then move gog.exe to a stable folder, for example:
   C:\Tools\gog\gog.exe
4. Add that folder to your user PATH in PowerShell:

[Environment]::SetEnvironmentVariable("Path", $env:Path + ";C:\Tools\gog", "User")

Close and reopen PowerShell after updating PATH.

Install method 2: Build from source (advanced)

Use this if you want the latest source build.

git clone https://github.com/steipete/gogcli.git
cd gogcli
# Requires Go + make-compatible tooling
make

After build, copy the produced Windows executable to a PATH folder (for example C:\Tools\gog).

PATH verification

where gog
gog --version
gog --help

If these commands work, installation + PATH are good.

Initial auth setup

1. Store OAuth desktop client credentials:

gog auth credentials C:\Users\<your-user>\Downloads\client_secret_XXXXX.json

2. Add your Google account (browser flow):

gog auth add you@gmail.com

3. (Optional) set a default account for this shell profile:

$env:GOG_ACCOUNT="you@gmail.com"

4. Run a smoke test:

gog auth status
gog gmail labels list

Common issues and troubleshooting

1) gog is not recognized

• Confirm gog.exe exists where you expect.
• Run echo $env:Path and confirm your gog folder is listed.
• Restart PowerShell/Terminal after PATH changes.

2) OAuth fails or browser callback does not complete

• Confirm OAuth Client type is Desktop app.
• If consent screen is in Testing mode, make sure your account is listed as a test user.
• Try manual flow for headless/locked-down environments:

gog auth add you@gmail.com --services user --manual

3) Permission or scope errors (403)

• Re-auth with required services/scopes, for example:

gog auth add you@gmail.com --services gmail,drive --force-consent

4) You actually intended gws (Google Workspace CLI npm package)

• That is a different CLI. Install with:

npm i -g @googleworkspace/cli
gws --help

Success checklist

• gog --version returns a version.
• gog auth status shows authenticated account/services.
• A first API command (like gog gmail labels list) succeeds.

Sources

• gogcli GitHub repository
• gogcli releases (Windows binaries)
• gogcli.sh quickstart/docs
• GitHub API (latest release assets)
• @googleworkspace/cli npm package (separate gws CLI)