documentation

Everything grr can do, verified against the source.

Five pages. Every command, flag, and method id on them was checked against the binary, the Rust source, and the committed Discovery index, so if it is written here it exists.

14 APIs · 402 methods · one generated tree

start here

Pick the page that matches what you are doing.

If you are here to install grr, read this one first. If you are wiring grr into an agent, skip to the last page.

Getting started Install on macOS, Linux, or Windows, log in once, run a real command, and check that auth and transport are healthy. Commands The naming rule that predicts any command from its method id, the typed-flag rules, per-service examples, the output formats, and how to configure System One for grr ask. Discovery API The index behind the whole tree: grr api list, describe, call, and refresh — 402 methods across 14 Google APIs. API reference Every one of the 402 methods across 14 services, baked from the committed Discovery index: verb, path, parameters, scopes, and a copyable command per method. Agents and harnesses The JSON output contract, how to discover capabilities instead of assuming them, the packaged agent skill, and where tokens live.

One index, two ways in

grr exposes the same Google account two ways, and both are generated from the same committed Discovery index — they cannot drift apart.

The generated tree is namespaced by service and mirrors Discovery method ids exactly: gmail.users.messages.list is grr gmail users messages list, with typed kebab-case flags per method. All 14 services in the index — gmail, calendar, drive, people, chat, forms, tasks, docs, sheets, slides, Apps Script, Analytics Admin, Analytics Data, and Search Console — have a full command path, and a daily workflow regenerates the tree when Google adds a method, with no grr release in between.

The flat view is grr api. It reads the same index by method id — list, describe, call, refresh — which is the convenient shape when you are composing ids dynamically or building tool definitions.

Both routes share one OAuth login, one transport, one call path, and one output contract. See Commands for the tree and Discovery API for the index.

terminal · grr

$ grr gmail users messages list --user-id me --max-results 5
$ grr sheets spreadsheets values get --spreadsheet-id 1a2b3c --range Sheet1!A1:D10
$ grr api call sheets.spreadsheets.values.get \
    --param spreadsheetId=1a2b3c --param range=A1:D10
$ grr auth status

what the index covers

14 services, one embedded index.

The table below is generated from the index grr embeds. Method counts are what grr api list reports at runtime.

Gmail

Messages, threads, drafts, labels, history, filters, forwarding, send-as, and settings.

79 methods · v1 · revision 20261106

grr gmail

Calendar

Calendars, events, instances, ACL, free/busy, colors, and settings.

38 methods · v3 · revision 20261109

grr calendar

Drive

Files, permissions, comments, revisions, changes, drives, and team drives.

64 methods · v3 · revision 20261109

grr drive

People (Contacts)

Contacts, connections, other contacts, contact groups, and directory people.

24 methods · v1 · revision 20261111

grr people

Chat

Spaces, messages, memberships, reactions, attachments, sections, and availability.

55 methods · v1 · revision 20261110

grr chat

Forms

Form bodies, responses, publish settings, and push-notification watches.

10 methods · v1 · revision 20261108

grr forms

Sheets

Spreadsheet values, batch updates, data filters, and developer metadata.

17 methods · v4 · revision 20261111

grr sheets

Tasks

Task lists and the tasks inside them. See the scope caveat below.

14 methods · v1 · revision 20261110

grr tasks

Slides

Presentation batch updates, page reads, and thumbnails.

5 methods · v1 · revision 20261109

grr slides

Docs

Document create, read, and batch update.

3 methods · v1 · revision 20261109

grr docs

Apps Script

Script projects, deployments, versions, processes, and running functions.

16 methods · v1 · revision 20261106

grr script

Analytics Admin

Accounts, properties, data streams, custom dimensions and metrics, conversion events, and the Ads and Firebase links.

55 methods · v1beta · revision 20261111

grr analyticsadmin

Analytics Data

Run reports — standard, realtime, pivot, and batch — plus compatibility checks, metadata, and audience exports.

11 methods · v1beta · revision 20261111

grr analyticsdata

Search Console

Search analytics queries, sitemaps, sites, and URL inspection.

11 methods · v1 · revision 20261110

grr searchconsole

Method totals and Discovery revisions come from the committed index at src/discovery/manifest.json, refreshed daily by the repository’s Discovery workflow. See Discovery API for the full breakdown and the one scope caveat that matters.

Beyond these pages

The binary is also its own contract: grr schema dumps the entire command tree as JSON, and grr <service> --help is always the last word on a flag.