gogcli/docs
Peter Steinberger 3ed52354a0
docs(skill): improve gog agent guidance (#552)
Co-authored-by: Tim Pietrusky <timpietrusky@gmail.com>
2026-05-05 02:47:31 +01:00
..
assets docs(site): add gogcli.sh landing page 2025-12-26 21:18:04 +01:00
commands feat(sheets): add conditional formatting and banding 2026-05-05 02:14:13 +01:00
refactor fix(docs): harden tab export landing 2026-04-28 06:30:38 +01:00
auth-clients.md feat(auth): add multi-org login 2026-01-22 04:04:14 +00:00
backup.md feat(safety): add baked safety profiles (#536) 2026-04-29 03:35:18 +01:00
CNAME docs(site): add gogcli.sh landing page 2025-12-26 21:18:04 +01:00
commands.generated.md feat(sheets): add conditional formatting and banding 2026-05-05 02:14:13 +01:00
contacts-json-update.md feat(contacts): update contacts from JSON 2026-02-14 15:31:14 +01:00
dates.md contacts: support --birthday and --notes in contacts update (#233) 2026-02-13 18:16:49 +01:00
email-tracking-worker.md fix(tracking): rotate email tracking keys 2026-04-28 10:22:55 +01:00
email-tracking.md fix(tracking): rotate email tracking keys 2026-04-28 10:22:55 +01:00
gmail-autoreply.md feat(gmail): add autoreply command 2026-03-13 17:02:21 +00:00
index.html docs: brew official formula (#361) 2026-03-07 23:32:53 +00:00
raw-audit.md feat(raw): add lossless API dump commands 2026-05-04 07:55:15 +01:00
README.md docs(skill): improve gog agent guidance (#552) 2026-05-05 02:47:31 +01:00
RELEASING.md chore(release): v0.11.0 2026-02-15 04:28:24 +01:00
safety-profiles.md fix(safety): compile baked policy to code to resist binary tampering 2026-05-04 05:55:05 +01:00
sedmat.md feat(sedmat): add paragraph addressing and structure introspection 2026-03-01 14:15:08 -05:00
sheets-formatting.md feat(sheets): add conditional formatting and banding 2026-05-05 02:14:13 +01:00
sheets-tables.md feat(sheets): clear table data rows 2026-05-04 23:14:42 +01:00
slides-markdown.md fix(auth): preserve accounts across Google email renames 2026-04-28 04:01:06 +01:00
slides-template-replacement.md feat(slides): add create-from-template command with text replacement 2026-03-08 04:43:36 +00:00
spec.md fix(auth): tolerate unreadable file keyring tokens 2026-04-28 09:15:19 +01:00
watch.md fix(gmail-watch): delay history fetch in watch serve (#397) 2026-03-07 14:54:54 +00:00

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 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.

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

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.