gogcli/docs

gog Docs

gog is a single CLI for Google Workspace automation: Gmail, Calendar, Drive, Docs, Sheets, Slides, Contacts, Tasks, People, Forms, Apps Script, Groups, Admin, Keep, and related agent workflows.

Start Here

• Install and authenticate from the repository README.
• Read Install and Runtime Packages when installing from Homebrew, Docker, GitHub releases, Windows ZIPs, or source.
• Read Auth Clients when setting up OAuth clients, service accounts, or Workspace domain-wide delegation.
• Read Command Guards and Baked Safety Profiles when running gog from agents or automation.
• Read the bundled gog agent skill when an agent needs safe auth preflight, JSON-first output, or guarded Workspace automation patterns.
• Read Sheets Tables when creating or inspecting Google Sheets structured tables.
• Open the Command Index for generated docs for every CLI command.

Feature Pages

• Install and Runtime Packages
• Auth Clients
• Command Guards and Baked Safety Profiles
• Raw API Dumps
• Raw API Sensitive Field Audit
• Gmail Workflows
• Gmail watch
• Email Tracking
• Drive Audits
• Contacts Dedupe Preview
• Contacts JSON Update
• Google Docs Editing
• Sheets Tables
• Sheets Formatting
• Slides from Markdown
• Slides Template Replacement
• Backups
• Date and Time Input Formats

Common Paths

gog auth add you@gmail.com --services gmail,calendar,drive
gog gmail search 'newer_than:7d' --max 10
gog gmail get <messageId> --sanitize-content --json
gog calendar events --today
gog drive ls --max 20

Command Docs

Every command page under docs/commands/ is generated from gog schema --json. Do not hand-edit generated command pages. After changing commands, flags, aliases, arguments, or help text, run:

make docs-commands

make docs-check verifies that every schema command has a generated page and that required feature pages are present and linked from this overview.

Then build the GitHub Pages site locally:

make docs-site
open dist/docs-site/index.html

The site is intentionally static: no framework, no package install, and no client-side dependency beyond a small navigation script embedded by the builder.