google-workspace-cli – Coding skill for AI agents
Google Workspace administration via the gws CLI (github.com/googleworkspace/cli). Install, authenticate, and automate Gmail, Drive, Sheets, Calendar, Docs, Chat, and Tasks. Run security audits and use local recipe templates and persona bundles. Use for Google Workspace admin, gws CLI setup, Gmail automation, Drive mana
Install the google-workspace-cli skill with one command
Pick the tool you use, copy the command and paste it in your terminal. The skill lands in that tool's skills folder and is ready in your next session.
Claude Code
mkdir -p ~/.claude/skills && curl -fsSL https://skill.dn1nguoi.com/z/google-workspace-cli-ad506.tgz | tar xz -C ~/.claude/skills
Call it in Claude Code: /google-workspace-cli – then describe the task you want done.
Codex
mkdir -p ~/.codex/skills && curl -fsSL https://skill.dn1nguoi.com/z/google-workspace-cli-ad506.tgz | tar xz -C ~/.codex/skills
Call it in Codex: $google-workspace-cli – then describe the task you want done.
Hermes Agent
mkdir -p ~/.hermes/skills && curl -fsSL https://skill.dn1nguoi.com/z/google-workspace-cli-ad506.tgz | tar xz -C ~/.hermes/skills
Call it in Hermes Agent: /google-workspace-cli – then describe the task you want done.
DeepSeek
mkdir -p ~/.deepcode/skills && curl -fsSL https://skill.dn1nguoi.com/z/google-workspace-cli-ad506.tgz | tar xz -C ~/.deepcode/skills
Call it in DeepSeek: /google-workspace-cli – then describe the task you want done.
SKILL.md content
Google Workspace CLI
Expert guidance and automation for Google Workspace administration using the open-source gws CLI ([github.com/googleworkspace/cli](https://github.com/googleworkspace/cli), Apache-2.0). The CLI builds its command surface dynamically from Google's Discovery Service, so it covers every supported Workspace API plus +-prefixed helper commands. This skill adds local Python tools (doctor, auth guide, recipe catalog, security audit, output analyzer).
> Verify before scripting: gws generates commands at runtime from Google's API discovery documents, and the CLI is pre-v1.0. Always confirm a command's exact surface with gws --help, gws <service> --help, or gws schema <service>.<resource>.<method> before putting it in automation. Commands in this skill marked *(verify)* are illustrative of the gws <service> <resource> <method> pattern and must be checked against your installed version.
---
Quick Start
Check Installation
# Verify gws is installed and authenticated
python3 scripts/gws_doctor.pySend an Email
gws gmail +send --to "[email protected]" \
--subject "Weekly Update" --body "Here's this week's summary..."List Drive Files
gws drive files list --params '{"pageSize": 20}' | python3 scripts/output_analyzer.py --select "name,mimeType,modifiedTime" --format table---
Installation
npm (recommended; requires Node.js 18+)
npm install -g @googleworkspace/cli
gws --versionHomebrew (macOS/Linux)
brew install googleworkspace-cliCargo (from source)
cargo install --git https://github.com/googleworkspace/cli --locked
gws --versionPre-built Binaries
Download from [github.com/googleworkspace/cli/releases](https://github.com/googleworkspace/cli/releases) for macOS, Linux, or Windows. Nix users: nix run github:googleworkspace/cli.
Verify Installation
python3 scripts/gws_doctor.py
# Checks: PATH, version, auth status, service connectivity---
Authentication
OAuth Setup (Interactive)
# Step 1: Create Google Cloud project and OAuth credentials
python3 scripts/auth_setup_guide.py --guide oauth
# Step 2: Run interactive auth setup (uses gcloud if available)
gws auth setup
# Step 3: Log in, requesting only the scopes you need
gws auth login -s drive,gmail,sheetsHeadless/CI
# Generate setup instructions
python3 scripts/auth_setup_guide.py --guide service-account
# Export credentials from an interactive machine, then point the CLI at them
gws auth export --unmasked > credentials.json
export GOOGLE_WORKSPACE_CLI_CREDENTIALS_FILE=/path/to/credentials.jsonEnvironment Variables
# Generate .env template
python3 scripts/auth_setup_guide.py --generate-env| Variable | Purpose |
|----------|---------|
| GOOGLE_WORKSPACE_CLI_CLIENT_ID | OAuth client ID |
| GOOGLE_WORKSPACE_CLI_CLIENT_SECRET | OAuth client secret |
| GOOGLE_WORKSPACE_CLI_CREDENTIALS_FILE | Path to exported credentials JSON |
| GOOGLE_WORKSPACE_CLI_TOKEN | Pre-obtained OAuth token |
| GOOGLE_WORKSPACE_CLI_CONFIG_DIR | Override default config location |
| GOOGLE_WORKSPACE_CLI_LOG | Enable debug logging |
Validate Authentication
python3 scripts/auth_setup_guide.py --validate --json
# Tests each service endpoint---
Workflow 1: Gmail Automation
Goal: Automate email operations — send, search, label, and filter management.
Send, Reply, Forward (helper commands)
# Send a new email
gws gmail +send --to "[email protected]" \
--subject "Proposal" --body "Please find attached..."
# Reply to a message (auto-threading); check exact flags with: gws gmail +reply --help
gws gmail +reply ...
# Forward a message; check exact flags with: gws gmail +forward --help
gws gmail +forward ...
# Unread inbox summary
gws gmail +triageSearch and Inspect (discovery commands)
Discovery commands follow gws <service> <resource> <method> and take request
parameters as JSON via --params (query/path params) and --json (request body).
Inspect any method's exact schema first:
# What does messages.list accept? (verify)
gws schema gmail.users.messages.list
# Search emails (verify against the schema above)
gws gmail users messages list --params '{"userId": "me", "q": "from:[email protected] after:2025/01/01"}' \
| python3 scripts/output_analyzer.py --count
# List labels (verify)
gws gmail users labels list --params '{"userId": "me"}'Bulk Operations
Use --dry-run first, and --page-all to paginate (one JSON line per page):
# Preview, then archive read emails older than 30 days (verify method schema first)
gws gmail users messages list --params '{"userId": "me", "q": "is:read older_than:30d"}' --page-all \
| python3 scripts/output_analyzer.py --select "id" --format json
# Then feed ids to gmail users messages modify (see: gws schema gmail.users.messages.modify)---
Workflow 2: Drive & Sheets
Goal: Manage files, create spreadsheets, configure sharing, and export data.
File Operations
# List files
gws drive files list --params '{"pageSize": 50}' \
| python3 scripts/output_analyzer.py --select "name,mimeType,size" --format table
# Upload a file (helper)
gws drive +upload ./report.pdf --name "Q1 Report"
# Create a Google Sheet
gws sheets spreadsheets create --json '{"properties": {"title": "Budget 2026"}}'
# Download/export — inspect the method first (verify)
gws schema drive.files.exportSharing (verify schemas first)
# Inspect the permissions API surface
gws schema drive.permissions.create
# Share with user (verify against schema)
gws drive permissions create --params '{"fileId": "<FILE_ID>"}' \
--json '{"type": "user", "role": "writer", "emailAddress": "[email protected]"}'
# List who has access (verify)
gws drive permissions list --params '{"fileId": "<FILE_ID>"}'Sheets Data
# Read values (helper); check exact flags with: gws sheets +read --help
gws sheets +read ...
# Append a row (helper); check exact flags with: gws sheets +append --help
gws sheets +append ...
# Or use discovery methods (verify):
gws schema sheets.spreadsheets.values.update
gws sheets spreadsheets values get --params '{"spreadsheetId": "<SHEET_ID>", "range": "Sheet1!A1:D10"}'---
Workflow 3: Calendar & Meetings
Goal: Schedule events, find available times, and generate standup reports.
Event Management
# Create an event (helper); check exact flags with: gws calendar +insert --help
gws calendar +insert ...
# Upcoming events (helper, timezone-aware)
gws calendar +agenda
# Or via discovery (verify):
gws schema calendar.events.insert
gws calendar events list --params '{"calendarId": "primary", "maxResults": 10}'Find Available Time
# Free/busy via the Calendar API (verify schema first)
gws schema calendar.freebusy.query
gws calendar freebusy query --json '{"timeMin": "...", "timeMax": "...", "items": [{"id": "[email protected]"}]}'Standup Report (workflow helpers)
# Today's meetings + tasks
gws workflow +standup-report \
| python3 scripts/output_analyzer.py --format table
# Next meeting prep; check exact flags with: gws workflow +meeting-prep --help
gws workflow +meeting-prep---
Workflow 4: Security Audit
Goal: Audit Google Workspace security configuration and generate remediation commands.
Run Full Audit
# Full audit across all services
python3 scripts/workspace_audit.py --json
# Audit specific services
python3 scripts/workspace_audit.py --services gmail,drive,calendar
# Demo mode (no gws required)
python3 scripts/workspace_audit.py --demoAudit Checks
| Area | Check | Risk |
|------|-------|------|
| Drive | External sharing enabled | Data exfiltration |
| Gmail | Auto-forwarding rules | Data exfiltration |
| Gmail | DMARC/SPF/DKIM records | Email spoofing |
| Calendar | Default sharing visibility | Information leak |
| OAuth | Third-party app grants | Unauthorized access |
| Admin | Super admin count | Privilege escalation |
| Admin | 2-Step verification enforcement | Account takeover |
Review and Remediate
# Review findings
python3 scripts/workspace_audit.py --json | python3 scripts/output_analyzer.py \
--filter "status=FAIL" --select "area,check,remediation"
# Execute remediation (example: check current Drive settings first; verify)
gws drive about get --params '{"fields": "*"}'
# Follow remediation commands from audit output (verify each against gws --help)---
Python Tools
| Script | Purpose | Usage |
|--------|---------|-------|
| gws_doctor.py | Pre-flight diagnostics | python3 scripts/gws_doctor.py [--json] [--services gmail,drive] |
| auth_setup_guide.py | Guided auth setup | python3 scripts/auth_setup_guide.py --guide oauth |
| gws_recipe_runner.py | Recipe catalog & runner | `python3
… (full content is in the download package)
Related skills
- c – Language-specific super-code guidelines for c.
- c-pro – Review and implement C systems code with explicit memory ownership, pointer bounds…
- c4-architecture-c4-architecture – Generate comprehensive C4 architecture documentation for an existing repository/codebase…
- python-configuration – Python configuration management via environment variables and typed settings. Use when…
- opencode – Delegate coding to OpenCode CLI (features, PR review).
- c4-code – Expert C4 Code-level documentation specialist. Analyzes code directories to create…
- c4-component – Expert C4 Component-level documentation specialist. Synthesizes C4 Code-level…
- python-design-patterns – Python design patterns including KISS, Separation of Concerns, Single Responsibility…