Use shared guidance for gws CLI authentication, command structure, and output formats. It covers checking requests without calling an API, retrieving multiple pages of results, handling files, and protecting sensitive information.
gws CLI: Shared patterns for authentication, global flags, and output formatting.
Review the instructions the agent will receive before you install.
The gws binary must be on $PATH. See the project README for install options.
# Browser-based OAuth (interactive)
gws auth login
# Service Account
export GOOGLE_APPLICATION_CREDENTIALS=/path/to/key.json
| Flag | Description |
|---|---|
--format <FORMAT> | Output format: json (default), table, yaml, csv |
--dry-run | Validate locally without calling the API |
--sanitize <TEMPLATE> | Screen responses through Model Armor |
gws <service> <resource> [sub-resource] <method> [flags]
| Flag | Description |
|---|---|
--params '{"key": "val"}' | URL/query parameters |
--json '{"key": "val"}' | Request body |
-o, --output <PATH> | Save binary responses to file |
--upload <PATH> | Upload file content (multipart) |
--page-all | Auto-paginate (NDJSON output) |
--page-limit <N> | Max pages when using --page-all (default: 10) |
--page-delay <MS> | Delay between pages in ms (default: 100) |
--dry-run for destructive operations--sanitize for PII/content safety screening! expansion: Sheet ranges like Sheet1!A1 contain ! which zsh interprets as history expansion. Use double quotes with escaped inner quotes instead of single quotes:
# WRONG (zsh will mangle the !)
gws sheets +read --spreadsheet ID --range 'Sheet1!A1:D10'
# CORRECT
gws sheets +read --spreadsheet ID --range "Sheet1!A1:D10"
--params and --json values in single quotes so the shell does not interpret the inner double quotes:
gws drive files list --params '{"pageSize": 5}'
https://github.com/googleworkspace/clihttps://github.com/googleworkspace/cli/issuesNo reviews yet. Tell others what you thought.
No login needed. Share how it worked for you, ask a question, or note where it did not run.
No comments yet. Be the first to write one.
Retrieve Google Workspace audit logs, which record account activity, and usage reports through gws. Review activity in applications such as the Admin console and Google Drive, or inspect statistics for the organization, users, and entities.
Manage Google Calendar events and calendars, including creating, updating, and deleting events. View upcoming events across calendars, check availability, and manage the permissions that control who can access a calendar.
View upcoming Google Calendar events across all calendars in one agenda. Check today, tomorrow, this week, or a chosen number of days, with options to filter calendars and change the display time zone.
Create a Google Calendar event with a title and start and end times. You can also choose a calendar, add a location and description, invite attendees, and include a Google Meet link.
Manage Google Chat spaces, the places where conversations happen, and their messages through the gws command-line tool. Create or update spaces, add members, send messages, and upload or download attachments.
Send plain text messages to a specified Google Chat space using the gws command line tool. Use it for team updates and announcements, with guidance on finding space identifiers and confirming messages before sending.