GAM Command Line Reference

A reference documentation library and interactive search tool for GAM (Google Workspace Admin Manager) — a command-line tool for managing Google Workspace.

Content is structured Markdown extracted and reorganized from the official GAM wiki, supplemented by a full BNF grammar reference and a Textual-based TUI for searching and generating commands.

Contents

• client_access/ — GAM commands using OAuth client credentials (admin-level). 69 topics covering users, groups, drive, chrome, and more.
• service_account_access/ — GAM commands requiring a service account with Domain-Wide Delegation (DWD). 44 topics covering Gmail, Drive, Calendar, and more.
• quick-reference/ — Cheat sheets, decision trees, and workflow summaries.
• definitions/ — Reusable type definitions (entities, attributes, list items).
• command_processing/ — Bulk processing, CSV handling, logging, and filtering.
• workflows/ — Detailed end-to-end workflow guides.
• GamCommands.txt — Complete BNF grammar for all ~1,035 GAM command variants (canonical upstream syntax reference).

See ARCHITECTURE.md for the access-pattern design rationale and CONTEXT.md for a unified glossary of terms.

GAM Command Search Tool

gam_search.py is a terminal UI for browsing, searching, and generating GAM commands from the documentation in this repo — including placeholder-filling command generation and clipboard copy.

Setup

Requires Python 3.11.9 (see .python-version).

pip install -r requirements.txt
python gam_search.py

See GAM_SEARCH_TOOL.md for full usage details, key bindings, and search behavior.

Attribution & License

This documentation is derived from the official GAM wiki and is licensed under the Apache License 2.0 — see LICENSE and ATTRIBUTION.md for details.