gws-shared
gws-shared is a reference guide for the gws CLI's core patterns: browser-based OAuth and service account authentication, global flags for output formatting and API validation, and method-specific options for pagination and file handling. It covers essential syntax, shell quoting tips, and security practices for working with Google Workspace APIs.
gws-shared documents the CLI syntax, authentication methods, and global flags for the gws Google Workspace command-line tool.
AI-generated summary based on this skill's SKILL.md
Decision gist · record as of 2026-07-22
gws-shared documents the CLI syntax, authentication methods, and global flags for the gws Google Workspace command-line tool. gws-shared is a reference guide for the gws CLI's core patterns: browser-based OAuth and service account authentication, global flags for output formatting and API validation, and method-specific options for pagination and file handling. It covers essential syntax, shell quoting tips, and security practices for working with Google Workspace APIs.
Use it when
- gws-shared covers both authentication approaches.
- gws-shared explains output formatting options through global flags that let you choose between JSON, table, YAML, and CSV formats.
Verify before relying
Read SKILL.md below before installing (1 file). Open directory: indexed for reading, not audited.
Install
googleworkspace/cli/gws-shared · repository language: Rust
Open directory. Skills are indexed for reading, not audited. Review a skill's body before installing it.
Frequently asked questions
AI-generated answers based on this skill's SKILL.md and metadata
What are gws CLI authentication and global flags?
gws-shared documents the core authentication methods and global flags for the gws CLI. Authentication options include browser-based OAuth login and service account setup. Global flags control output formatting (JSON, table, YAML, CSV), API response handling, dry-run validation, and pagination behavior. These flags apply across all gws commands and enable you to customize how results are displayed and processed.
How do I set up OAuth or service account authentication in gws?
gws-shared covers both authentication approaches. OAuth uses browser-based login for interactive sessions, while service account authentication uses credentials stored in environment variables or configuration files. The guide explains credential management, environment variable setup, and best practices for securing credentials. Choose OAuth for interactive use and service accounts for automated workflows or CI/CD pipelines.
How can I configure gws output formatting (JSON, table, YAML, CSV)?
gws-shared explains output formatting options through global flags that let you choose between JSON, table, YAML, and CSV formats. These flags control how API responses are displayed and parsed. You can apply formatting globally across commands or override it per-command. The guide covers API response handling to ensure your chosen format matches your downstream processing needs.
What does gws dry run validation do and how do I use it?
gws-shared describes the dry-run option as a validation mechanism that simulates command execution without making destructive changes. Use dry-run flags to preview operations, test pagination settings, and confirm parameter syntax before applying them. This is especially useful for validating complex queries, file uploads, and API calls that modify data.
What security best practices and shell escaping techniques does gws-shared cover?
gws-shared provides guidance on shell quoting, history expansion handling (especially in zsh), and PII screening practices. It covers proper parameter escaping to prevent injection attacks, credential protection strategies, and safe handling of sensitive data in command-line arguments. The guide emphasizes shell tips to avoid common mistakes when constructing gws commands with special characters.
How do pagination, file upload, and method-specific options work in gws?
gws-shared explains pagination with auto-paginate settings, page delay limits, and result limits for handling large datasets. File upload options cover multipart uploads and parameter handling. Method-specific options vary by command but are documented with examples. The guide shows how to combine these features for efficient API interactions and bulk operations.
SKILL.md
Rendered from the published skill. Quoted content, verbatim.
gws — Shared Reference
Installation
The gws binary must be on $PATH. See the project README for install options.
Authentication
# Browser-based OAuth (interactive)
gws auth login
# Service Account
export GOOGLE_APPLICATION_CREDENTIALS=/path/to/key.json
Global Flags
| 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 |
CLI Syntax
gws <service> <resource> [sub-resource] <method> [flags]
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) |
(truncated - see the full file via the links below)
File tree — 1 file
skills/gws-shared/SKILL.md
Let your AI agent find skills like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 56,283 agent skills by what they can do, searchable in plain language.
wish › “Learn gws CLI syntax, global flags, and authentication methods”
Give your agent the search over MCP, or paste the wish link into any chat. No install? Search from any chat →
Related skills
A single command-line interface that connects to every Google Workspace API, from Drive and Gmail to Calendar, Sheets, Docs, Slides, Chat, and Admin tools. The CLI dynamically discovers available endpoints at runtime, so new Google APIs are supported automatically without updates. Built for both human operators and AI agents with JSON-structured output.
Gws is a command-line interface for Google Workspace that streamlines email triage, calendar management, file uploads, spreadsheet operations, and task creation. It supports helper commands for common workflows like standup reports and meeting prep, plus raw API access for advanced use cases. Built for both interactive queries and scripted automation.
Google Workspace brings Gmail, Calendar, Drive, Sheets, and Docs into your agent through a Python wrapper around Google's official gws CLI. Setup handles OAuth2 authorization once, then token refresh happens automatically. Search emails, manage events, query files, read spreadsheets, and access contacts—all via a unified command interface.
Display upcoming events from all your Google calendars in one view. Filter by today, tomorrow, this week, or a custom number of days ahead, and optionally narrow to a specific calendar or timezone.
This protocol enforces a three-stage quality check for Rust code: format validation, clippy linting, and test execution, each halting on failure. It's designed for the trusty-tools monorepo and clarifies crate naming conventions, test output interpretation, and handling of pre-existing failures. Use it before any PR merge or when code changes are ready to commit.
Send replies to Gmail messages with built-in thread management and automatic quoting of the original message. Supports attachments, CC/BCC recipients, HTML formatting, and draft saving through simple command-line flags.