GWS CLI Reference
Class-level reference for the generated Google Workspace CLI skill family. Prefer this umbrella instead of narrow per-service helpers.
Core workflow
- Authenticate once with
gws auth loginor service-account env vars. - Start from
gws <service> --helpto see resources. - Inspect a concrete method with
gws schema <service>.<resource>.<method>before building flags. - Prefer
--dry-runfor writes and any bulk operation. - Use
--format tablefor quick scans,jsonfor piping,csvfor exports.
Shared command pattern
gws <service> <resource> [sub-resource] <method> [flags]
Common flags:
--params '{...}'for query/path params--json '{...}'for request bodies--upload <path>for file content--output <path>for downloads/exports--page-allfor paginated listings--sanitize <template>when Model Armor screening is relevant
Service map
Communication
- Gmail: message/thread/draft/label/history operations, triage, reply, forward, send, watch.
- Chat: spaces, messages, announcements.
- Meet: conference management.
Scheduling
- Calendar: calendars, ACLs, freebusy, events, agenda views, quick event insertion.
Files and docs
- Drive: files, permissions, comments, shared drives, uploads, change watches.
- Docs / Sheets / Slides / Forms: content read/write and file-specific operations.
People and org data
- People, Classroom, Admin Reports, Tasks, Keep.
Safety and eventing
- Events / events subscriptions / renewals.
- Model Armor template creation plus prompt/response sanitization.
Workflow helpers
- Meeting prep, standup reports, weekly digests, email-to-task, file announcements.
Helper-command selection
Use the short helper form when it clearly matches the job:
- Calendar helpers:
+agenda,+insert - If
gwsis unavailable butgogis available, usereferences/gog-calendar-oauth-recovery.mdfor Calendar OAuth recovery and agenda listing viagog calendar events. - Gmail helpers:
+send,+triage,+reply,+reply-all,+forward,+watch - Gmail helpers:
+send,+triage,+reply,+reply-all,+forward,+watch - Drive helper:
+upload - Workflow helpers:
+meeting-prep,+standup-report,+weekly-digest,+email-to-task,+file-announce - Events helpers: renew or subscribe when maintaining watches
- Model Armor helpers: create-template, sanitize-prompt, sanitize-response
When to branch into references
Read references/services-index.md when choosing a service or helper. Read references/absorbed-skills.md when you need the exact old micro-skill names that were absorbed here.
Safety rules
- Confirm scope before destructive writes/deletes/shares.
- Use
--dry-runbefore multi-item changes. - For permissions/sharing, verify target IDs and recipient emails first.
- For watches/subscriptions, record renewal requirements.
Verification checklist
- Chosen the right service for the user task
- Inspected schema before constructing the call
- Used dry-run or read-before-write when possible
- Captured resulting IDs/URLs/status from the command output