Commands

Every gog command has a generated docs page. The source of truth is the live CLI schema; run make docs-commands after changing command names, flags, help text, aliases, or arguments.

Generated pages: 470.

#Top-level Commands

gog admin - Google Workspace Admin (Directory API) - requires domain-wide delegation
gog agent - Agent-friendly helpers
gog appscript - Google Apps Script
gog auth - Auth and credentials
gog backup - Encrypted Google account backups
gog calendar - Google Calendar
gog chat - Google Chat
gog classroom - Google Classroom
gog completion - Generate shell completion scripts
gog config - Manage configuration
gog contacts - Google Contacts
gog docs - Google Docs (export via Drive)
gog download - Download a Drive file (alias for 'drive download')
gog drive - Google Drive
gog exit-codes - Print stable exit codes (alias for 'agent exit-codes')
gog forms - Google Forms
gog gmail - Gmail
gog groups - Google Groups
gog keep - Google Keep (Workspace only)
gog login - Authorize and store a refresh token (alias for 'auth add')
gog logout - Remove a stored refresh token (alias for 'auth remove')
gog ls - List Drive files (alias for 'drive ls')
gog me - Show your profile (alias for 'people me')
gog open - Print a best-effort web URL for a Google URL/ID (offline)
gog people - Google People
gog schema - Machine-readable command/flag schema
gog search - Search Drive files (alias for 'drive search')
gog send - Send an email (alias for 'gmail send')
gog sheets - Google Sheets
gog slides - Google Slides
gog status - Show auth/config status (alias for 'auth status')
gog tasks - Google Tasks
gog time - Local time utilities
gog upload - Upload a file to Drive (alias for 'drive upload')
gog version - Print version
gog whoami - Show your profile (alias for 'people me')

#All Commands

gog - Google CLI for Gmail/Calendar/Chat/Classroom/Drive/Contacts/Tasks/Sheets/Docs/Slides/People/Forms/App Script/Ads/Groups/Admin/Keep
gog admin - Google Workspace Admin (Directory API) - requires domain-wide delegation
gog admin groups - Manage Workspace groups
gog admin groups list - List groups in a domain
gog admin groups members - Manage group members
gog admin groups members add - Add a member to a group
gog admin groups members list - List group members
gog admin groups members remove - Remove a member from a group
gog admin users - Manage Workspace users
gog admin users create - Create a new user
gog admin users get - Get user details
gog admin users list - List users in a domain
gog admin users suspend - Suspend a user account
gog agent - Agent-friendly helpers
gog agent exit-codes - Print stable exit codes for automation
gog appscript - Google Apps Script
gog appscript content - Get Apps Script project content
gog appscript create - Create an Apps Script project
gog appscript get - Get Apps Script project metadata
gog appscript run - Run a deployed Apps Script function
gog auth - Auth and credentials
gog auth add - Authorize and store a refresh token
gog auth alias - Manage account aliases
gog auth alias list - List account aliases
gog auth alias set - Set an account alias
gog auth alias unset - Remove an account alias
gog auth credentials - Manage OAuth client credentials
gog auth credentials list - List stored OAuth client credentials
gog auth credentials remove - Remove stored OAuth client credentials
gog auth credentials set - Store OAuth client credentials
gog auth doctor - Diagnose auth, keyring, and refresh-token issues
gog auth keep - Configure service account for Google Keep (Workspace only)
gog auth keyring - Configure keyring backend
gog auth list - List stored accounts
gog auth manage - Open accounts manager in browser
gog auth remove - Remove a stored refresh token
gog auth service-account - Configure service account (Workspace only; domain-wide delegation)
gog auth service-account set - Store a service account key for impersonation
gog auth service-account status - Show stored service account key status
gog auth service-account unset - Remove stored service account key
gog auth services - List supported auth services and scopes
gog auth status - Show auth configuration and keyring backend
gog auth tokens - Manage stored refresh tokens
gog auth tokens delete - Delete a stored refresh token
gog auth tokens export - Export a refresh token to a file (contains secrets)
gog auth tokens import - Import a refresh token file into keyring (contains secrets)
gog auth tokens list - List stored tokens (by key only)
gog backup - Encrypted Google account backups
gog backup cat - Decrypt one backup shard to stdout
gog backup export - Write a local plaintext export
gog backup gmail - Gmail backup operations
gog backup gmail push - Export Gmail into encrypted backup shards
gog backup init - Initialize encrypted backup config and repository
gog backup push - Export services into encrypted backup shards
gog backup status - Inspect backup manifest without decrypting shards
gog backup verify - Decrypt and verify all backup shards
gog calendar - Google Calendar
gog calendar acl - List calendar ACL
gog calendar alias - Manage calendar aliases
gog calendar alias list - List calendar aliases
gog calendar alias set - Set a calendar alias
gog calendar alias unset - Remove a calendar alias
gog calendar calendars - List calendars
gog calendar colors - Show calendar colors
gog calendar conflicts - Find conflicts
gog calendar create - Create an event
gog calendar create-calendar - Create a new secondary calendar
gog calendar delete - Delete an event
gog calendar event - Get event
gog calendar events - List events from a calendar or all calendars
gog calendar focus-time - Create a Focus Time block
gog calendar freebusy - Get free/busy
gog calendar move - Move an event to another calendar
gog calendar out-of-office - Create an Out of Office event
gog calendar propose-time - Generate URL to propose a new meeting time (browser-only feature)
gog calendar raw - Dump raw Google Calendar API response as JSON (Events.Get; lossless; for scripting and LLM consumption)
gog calendar respond - Respond to an event invitation
gog calendar search - Search events
gog calendar subscribe - Add a calendar to your calendar list
gog calendar team - Show events for all members of a Google Group
gog calendar time - Show server time
gog calendar update - Update an event
gog calendar users - List workspace users (use their email as calendar ID)
gog calendar working-location - Set working location (home/office/custom)
gog chat - Google Chat
gog chat dm - Direct messages
gog chat dm send - Send a direct message
gog chat dm space - Find or create a DM space
gog chat messages - Chat messages
gog chat messages list - List messages
gog chat messages react - Add an emoji reaction to a message
gog chat messages reactions - Manage emoji reactions on a message
gog chat messages reactions create - Add an emoji reaction to a message
gog chat messages reactions delete - Delete a reaction
gog chat messages reactions list - List reactions on a message
gog chat messages send - Send a message
gog chat spaces - Chat spaces
gog chat spaces create - Create a space
gog chat spaces find - Find spaces by display name
gog chat spaces list - List spaces
gog chat threads - Chat threads
gog chat threads list - List threads in a space
gog classroom - Google Classroom
gog classroom announcements - Announcements
gog classroom announcements assignees - Modify announcement assignees
gog classroom announcements create - Create an announcement
gog classroom announcements delete - Delete an announcement
gog classroom announcements get - Get an announcement
gog classroom announcements list - List announcements
gog classroom announcements update - Update an announcement
gog classroom courses - Courses
gog classroom courses archive - Archive a course
gog classroom courses create - Create a course
gog classroom courses delete - Delete a course
gog classroom courses get - Get a course
gog classroom courses join - Join a course
gog classroom courses leave - Leave a course
gog classroom courses list - List courses
gog classroom courses unarchive - Unarchive a course
gog classroom courses update - Update a course
gog classroom courses url - Print Classroom web URLs for courses
gog classroom coursework - Coursework
gog classroom coursework assignees - Modify coursework assignees
gog classroom coursework create - Create coursework
gog classroom coursework delete - Delete coursework
gog classroom coursework get - Get coursework
gog classroom coursework list - List coursework
gog classroom coursework update - Update coursework
gog classroom guardian-invitations - Guardian invitations
gog classroom guardian-invitations create - Create a guardian invitation
gog classroom guardian-invitations get - Get a guardian invitation
gog classroom guardian-invitations list - List guardian invitations
gog classroom guardians - Guardians
gog classroom guardians delete - Delete a guardian
gog classroom guardians get - Get a guardian
gog classroom guardians list - List guardians
gog classroom invitations - Invitations
gog classroom invitations accept - Accept an invitation
gog classroom invitations create - Create an invitation
gog classroom invitations delete - Delete an invitation
gog classroom invitations get - Get an invitation
gog classroom invitations list - List invitations
gog classroom materials - Coursework materials
gog classroom materials create - Create coursework material
gog classroom materials delete - Delete coursework material
gog classroom materials get - Get coursework material
gog classroom materials list - List coursework materials
gog classroom materials update - Update coursework material
gog classroom profile - User profiles
gog classroom profile get - Get a user profile
gog classroom roster - Course roster (students + teachers)
gog classroom students - Course students
gog classroom students add - Add a student
gog classroom students get - Get a student
gog classroom students list - List students
gog classroom students remove - Remove a student
gog classroom submissions - Student submissions
gog classroom submissions get - Get a student submission
gog classroom submissions grade - Set draft/assigned grades
gog classroom submissions list - List student submissions
gog classroom submissions reclaim - Reclaim a submission
gog classroom submissions return - Return a submission
gog classroom submissions turn-in - Turn in a submission
gog classroom teachers - Course teachers
gog classroom teachers add - Add a teacher
gog classroom teachers get - Get a teacher
gog classroom teachers list - List teachers
gog classroom teachers remove - Remove a teacher
gog classroom topics - Topics
gog classroom topics create - Create a topic
gog classroom topics delete - Delete a topic
gog classroom topics get - Get a topic
gog classroom topics list - List topics
gog classroom topics update - Update a topic
gog completion - Generate shell completion scripts
gog config - Manage configuration
gog config get - Get a config value
gog config keys - List available config keys
gog config list - List all config values
gog config no-send - Manage per-account Gmail no-send guards
gog config no-send list - List accounts with no-send guards
gog config no-send remove - Remove an account no-send guard
gog config no-send set - Block Gmail send operations for an account
gog config path - Print config file path
gog config set - Set a config value
gog config unset - Unset a config value
gog contacts - Google Contacts
gog contacts create - Create a contact
gog contacts dedupe - Find likely duplicate contacts (preview only)
gog contacts delete - Delete a contact
gog contacts directory - Directory contacts
gog contacts directory list - List people from the Workspace directory
gog contacts directory search - Search people in the Workspace directory
gog contacts export - Export contacts as vCard (.vcf)
gog contacts get - Get a contact
gog contacts list - List contacts
gog contacts other - Other contacts
gog contacts other delete - Delete an other contact
gog contacts other list - List other contacts
gog contacts other search - Search other contacts
gog contacts raw - Dump raw People API response as JSON (People.Get; lossless; for scripting and LLM consumption)
gog contacts search - Search contacts by name/email/phone
gog contacts update - Update a contact
gog docs - Google Docs (export via Drive)
gog docs add-tab - Add a tab to a Google Doc
gog docs cat - Print a Google Doc as plain text
gog docs clear - Clear all content from a Google Doc
gog docs comments - Manage comments on files
gog docs comments add - Add a comment to a Google Doc
gog docs comments delete - Delete a comment
gog docs comments get - Get a comment by ID
gog docs comments list - List comments on a Google Doc
gog docs comments reply - Reply to a comment
gog docs comments resolve - Resolve a comment (mark as done)
gog docs copy - Copy a Google Doc
gog docs create - Create a Google Doc
gog docs delete - Delete text range from document
gog docs delete-tab - Delete a tab from a Google Doc
gog docs edit - Find and replace text in a Google Doc
gog docs export - Export a Google Doc (pdf|docx|txt|md|html)
gog docs find-replace - Find and replace text. Supports plain text or markdown with images; use --first for a single occurrence.
gog docs format - Apply text or paragraph formatting to a Google Doc
gog docs info - Get Google Doc metadata
gog docs insert - Insert text at a specific position
gog docs list-tabs - List all tabs in a Google Doc
gog docs raw - Dump raw Google Docs API response as JSON (Documents.Get; lossless; for scripting and LLM consumption)
gog docs rename-tab - Rename a tab in a Google Doc
gog docs sed - Regex find/replace (sed-style: s/pattern/replacement/g)
gog docs structure - Show document structure with numbered paragraphs
gog docs update - Insert text at a specific index in a Google Doc
gog docs write - Write content to a Google Doc
gog download - Download a Drive file (alias for 'drive download')
gog drive - Google Drive
gog drive comments - Manage comments on files
gog drive comments create - Create a comment on a file
gog drive comments delete - Delete a comment
gog drive comments get - Get a comment by ID
gog drive comments list - List comments on a file
gog drive comments reply - Reply to a comment
gog drive comments update - Update a comment
gog drive copy - Copy a file
gog drive delete - Move a file to trash (use --permanent to delete forever)
gog drive download - Download a file (exports Google Docs formats)
gog drive drives - List shared drives (Team Drives)
gog drive du - Summarize Drive folder sizes
gog drive get - Get file metadata
gog drive inventory - Export a read-only Drive inventory
gog drive ls - List files in a folder (default: root)
gog drive mkdir - Create a folder
gog drive move - Move a file to a different folder
gog drive permissions - List permissions on a file
gog drive raw - Dump raw Google Drive API response as JSON (Files.Get; lossless; for scripting and LLM consumption)
gog drive rename - Rename a file or folder
gog drive search - Full-text search across Drive
gog drive share - Share a file or folder
gog drive tree - Print a read-only folder tree
gog drive unshare - Remove a permission from a file
gog drive upload - Upload a file
gog drive url - Print web URLs for files
gog exit-codes - Print stable exit codes (alias for 'agent exit-codes')
gog forms - Google Forms
gog forms add-question - Add a question to a form
gog forms create - Create a form
gog forms delete-question - Delete a question by index
gog forms get - Get a form
gog forms move-question - Move a question to a new position
gog forms raw - Dump raw Google Forms API response as JSON (Forms.Get; lossless; for scripting and LLM consumption)
gog forms responses - Form responses
gog forms responses get - Get a form response
gog forms responses list - List form responses
gog forms update - Update form title, description, or settings
gog forms watch - Response watches (push notifications)
gog forms watch create - Create a watch for new responses
gog forms watch delete - Delete a watch
gog forms watch list - List active watches
gog forms watch renew - Renew a watch (extends 7 days)
gog gmail - Gmail
gog gmail archive - Archive messages (remove from inbox)
gog gmail attachment - Download a single attachment
gog gmail autoreply - Reply once to matching messages
gog gmail batch - Batch operations (permanent delete requires broader Gmail scope; use gmail trash for normal trashing)
gog gmail batch delete - Permanently delete multiple messages; use 'gmail trash' to move messages to trash with the default gmail.modify scope
gog gmail batch modify - Modify labels on multiple messages
gog gmail drafts - Draft operations
gog gmail drafts create - Create a draft
gog gmail drafts delete - Delete a draft
gog gmail drafts get - Get draft details
gog gmail drafts list - List drafts
gog gmail drafts send - Send a draft
gog gmail drafts update - Update a draft
gog gmail forward - Forward a message to new recipients
gog gmail get - Get a message (full|metadata|raw)
gog gmail history - Gmail history
gog gmail labels - Label operations
gog gmail labels create - Create a new label
gog gmail labels delete - Delete a label
gog gmail labels get - Get label details (including counts)
gog gmail labels list - List labels
gog gmail labels modify - Modify labels on threads
gog gmail labels rename - Rename a label
gog gmail labels style - Change a user label color or visibility
gog gmail mark-read - Mark messages as read
gog gmail messages - Message operations
gog gmail messages modify - Modify labels on a single message
gog gmail messages search - Search messages using Gmail query syntax
gog gmail raw - Dump raw Gmail API response as JSON (Users.Messages.Get; lossless; for scripting and LLM consumption)
gog gmail search - Search threads using Gmail query syntax
gog gmail send - Send an email
gog gmail settings - Settings and admin
gog gmail settings autoforward - Auto-forwarding settings
gog gmail settings autoforward get - Get current auto-forwarding settings
gog gmail settings autoforward update - Update auto-forwarding settings
gog gmail settings delegates - Delegate operations
gog gmail settings delegates add - Add a delegate
gog gmail settings delegates get - Get a specific delegate's information
gog gmail settings delegates list - List all delegates
gog gmail settings delegates remove - Remove a delegate
gog gmail settings filters - Filter operations
gog gmail settings filters create - Create a new email filter
gog gmail settings filters delete - Delete a filter
gog gmail settings filters export - Export filters as Gmail WebUI-compatible XML
gog gmail settings filters get - Get a specific filter
gog gmail settings filters list - List all email filters
gog gmail settings forwarding - Forwarding addresses
gog gmail settings forwarding create - Create/add a forwarding address
gog gmail settings forwarding delete - Delete a forwarding address
gog gmail settings forwarding get - Get a specific forwarding address
gog gmail settings forwarding list - List all forwarding addresses
gog gmail settings sendas - Send-as settings
gog gmail settings sendas create - Create a new send-as alias
gog gmail settings sendas delete - Delete a send-as alias
gog gmail settings sendas get - Get details of a send-as alias
gog gmail settings sendas list - List send-as aliases
gog gmail settings sendas update - Update a send-as alias
gog gmail settings sendas verify - Resend verification email for a send-as alias
gog gmail settings vacation - Vacation responder
gog gmail settings vacation get - Get current vacation responder settings
gog gmail settings vacation update - Update vacation responder settings
gog gmail settings watch - Manage Gmail watch
gog gmail settings watch renew - Renew Gmail watch using stored config
gog gmail settings watch serve - Run Pub/Sub push handler
gog gmail settings watch start - Start Gmail watch for Pub/Sub
gog gmail settings watch status - Show stored watch state
gog gmail settings watch stop - Stop Gmail watch and clear stored state
gog gmail thread - Thread operations (get, modify)
gog gmail thread attachments - List all attachments in a thread
gog gmail thread get - Get a thread with all messages (optionally download attachments)
gog gmail thread modify - Modify labels on all messages in a thread
gog gmail track - Email open tracking
gog gmail track key - Manage tracking encryption keys
gog gmail track key rotate - Rotate tracking encryption key
gog gmail track opens - Query email opens
gog gmail track setup - Set up email tracking (deploy Cloudflare Worker)
gog gmail track status - Show tracking configuration status
gog gmail trash - Move messages to trash
gog gmail unread - Mark messages as unread
gog gmail url - Print Gmail web URLs for threads
gog groups - Google Groups
gog groups list - List groups you belong to
gog groups members - List members of a group
gog keep - Google Keep (Workspace only)
gog keep attachment - Download an attachment
gog keep create - Create a new note
gog keep delete - Delete a note
gog keep get - Get a note
gog keep list - List notes
gog keep search - Search notes by text (client-side)
gog login - Authorize and store a refresh token (alias for 'auth add')
gog logout - Remove a stored refresh token (alias for 'auth remove')
gog ls - List Drive files (alias for 'drive ls')
gog me - Show your profile (alias for 'people me')
gog open - Print a best-effort web URL for a Google URL/ID (offline)
gog people - Google People
gog people get - Get a user profile by ID
gog people me - Show your profile (people/me)
gog people raw - Dump raw People API response as JSON (People.Get; lossless; for scripting and LLM consumption)
gog people relations - Get user relations
gog people search - Search the Workspace directory
gog schema - Machine-readable command/flag schema
gog search - Search Drive files (alias for 'drive search')
gog send - Send an email (alias for 'gmail send')
gog sheets - Google Sheets
gog sheets add-tab - Add a new tab/sheet to a spreadsheet
gog sheets append - Append values to a range
gog sheets banding - Manage alternating color banding
gog sheets banding clear - Remove alternating color banding
gog sheets banding list - List alternating color banded ranges
gog sheets banding set - Apply alternating colors to a range
gog sheets chart - Manage spreadsheet charts
gog sheets chart create - Create a chart from a JSON spec
gog sheets chart delete - Delete a chart
gog sheets chart get - Get full chart definition (spec + position)
gog sheets chart list - List charts in a spreadsheet
gog sheets chart update - Update a chart spec
gog sheets clear - Clear values in a range
gog sheets conditional-format - Manage conditional formatting rules
gog sheets conditional-format add - Add a conditional formatting rule
gog sheets conditional-format clear - Remove conditional formatting rules
gog sheets conditional-format list - List conditional formatting rules
gog sheets copy - Copy a Google Sheet
gog sheets create - Create a new spreadsheet
gog sheets delete-tab - Delete a tab/sheet from a spreadsheet (use --force to skip confirmation)
gog sheets export - Export a Google Sheet (pdf|xlsx|csv) via Drive
gog sheets find-replace - Find and replace text across a spreadsheet
gog sheets format - Apply cell formatting to a range
gog sheets freeze - Freeze rows and columns on a sheet
gog sheets get - Get values from a range
gog sheets insert - Insert empty rows or columns into a sheet
gog sheets links - Get cell hyperlinks from a range
gog sheets merge - Merge cells in a range
gog sheets metadata - Get spreadsheet metadata
gog sheets named-ranges - Manage named ranges
gog sheets named-ranges add - Add a named range
gog sheets named-ranges delete - Delete a named range
gog sheets named-ranges get - Get a named range
gog sheets named-ranges list - List named ranges
gog sheets named-ranges update - Update a named range
gog sheets notes - Get cell notes from a range
gog sheets number-format - Apply number format to a range
gog sheets raw - Dump raw Google Sheets API response as JSON (Spreadsheets.Get; lossless; for scripting and LLM consumption)
gog sheets read-format - Read cell formatting from a range
gog sheets rename-tab - Rename a tab/sheet in a spreadsheet
gog sheets resize-columns - Resize sheet columns
gog sheets resize-rows - Resize sheet rows
gog sheets table - Manage Google Sheets tables
gog sheets table append - Append rows to a table
gog sheets table clear - Clear table data rows
gog sheets table create - Create a table
gog sheets table delete - Delete a table
gog sheets table get - Get a table
gog sheets table list - List tables in a spreadsheet
gog sheets unmerge - Unmerge cells in a range
gog sheets update - Update values in a range
gog sheets update-note - Set or clear a cell note
gog slides - Google Slides
gog slides add-slide - Add a slide with a full-bleed image and optional speaker notes
gog slides copy - Copy a Google Slides presentation
gog slides create - Create a Google Slides presentation
gog slides create-from-markdown - Create a Google Slides presentation from markdown
gog slides create-from-template - Create a presentation from template with text replacements
gog slides delete-slide - Delete a slide by object ID
gog slides export - Export a Google Slides deck (pdf|pptx)
gog slides info - Get Google Slides presentation metadata
gog slides insert-text - Insert text into an existing page element (shape or table) by objectId
gog slides list-slides - List all slides with their object IDs
gog slides raw - Dump raw Google Slides API response as JSON (Presentations.Get; lossless; for scripting and LLM consumption)
gog slides read-slide - Read slide content: speaker notes, text elements, and images
gog slides replace-slide - Replace the image on an existing slide in-place
gog slides replace-text - Find-and-replace text across a presentation
gog slides thumbnail - Get or download a rendered thumbnail for a slide
gog slides update-notes - Update speaker notes on an existing slide
gog status - Show auth/config status (alias for 'auth status')
gog tasks - Google Tasks
gog tasks add - Add a task
gog tasks clear - Clear completed tasks
gog tasks delete - Delete a task
gog tasks done - Mark task completed
gog tasks get - Get a task
gog tasks list - List tasks
gog tasks lists - List task lists
gog tasks lists create - Create a task list
gog tasks lists list - List task lists
gog tasks raw - Dump raw Google Tasks API response as JSON (Tasks.Get; lossless; for scripting and LLM consumption)
gog tasks undo - Mark task needs action
gog tasks update - Update a task
gog time - Local time utilities
gog time now - Show current time
gog upload - Upload a file to Drive (alias for 'drive upload')
gog version - Print version
gog whoami - Show your profile (alias for 'people me')