Google Workspace CLI

Category: Engineering Domain: Google Workspace Administration

Overview

The Google Workspace CLI skill provides tools for auditing Google Workspace configurations, generating authentication setup documentation, and diagnosing common GWS issues. It helps IT administrators maintain secure, well-configured Workspace environments without needing to navigate complex admin consoles.

Clarify First

Before running, confirm these inputs. If any is unknown or vague, ASK — do not assume:

• Task — security audit, auth setup guide, or diagnostics (selects workspace_audit.py vs auth_setup_guide.py vs gws_doctor.py)
• Config export or auth method — the GWS config JSON to audit, or the auth method and scopes for a setup guide (sets --config or --method/--scopes)
• Output mode — human-readable vs JSON for automation (sets --format json)

Stop rule: ask only the 2-3 that most change the output. If the user says "just draft it," proceed and list your assumptions at the top of the artifact.

Quick Start

# Audit Workspace security configuration
python scripts/workspace_audit.py --config gws-config.json

# Generate auth setup guide
python scripts/auth_setup_guide.py --method oauth --scopes admin,drive

# Run diagnostics
python scripts/gws_doctor.py --check all

# JSON output for automation
python scripts/workspace_audit.py --config gws-config.json --format json

Tools Overview

workspace_audit.py

Audits Google Workspace configuration exports for security best practices.

auth_setup_guide.py

Generates step-by-step authentication setup documentation for GWS API access.

gws_doctor.py

Diagnostic tool for common Google Workspace configuration issues.

Workflows

Security Audit Workflow

1. Export config - Export GWS settings to JSON via Admin SDK or manual export
2. Audit - Run workspace_audit.py against the config file
3. Review findings - Prioritize critical security gaps
4. Remediate - Apply recommended settings in Admin Console
5. Re-audit - Verify changes resolved findings

API Setup Workflow

1. Plan - Determine which APIs and scopes are needed
2. Generate guide - Run auth_setup_guide.py with desired method
3. Follow steps - Create credentials in Google Cloud Console
4. Configure - Set up domain delegation if needed
5. Verify - Test API access with provided verification steps

Health Check Workflow

1. Run diagnostics - Execute gws_doctor.py with all checks
2. Review results - Check DNS, email, and integration health
3. Fix issues - Address failures in priority order
4. Re-check - Verify fixes pass diagnostics

Regular Maintenance

# Monthly security audit
python scripts/workspace_audit.py --config gws-export.json --format json > audit_$(date +%Y%m).json

# Weekly health check
python scripts/gws_doctor.py --check dns,email --format json

Reference Documentation

• GWS Admin Guide - Security settings, API configuration, DNS requirements

Common Patterns Quick Reference

Security Priorities

DNS Records for Email

API Scopes

Common Issues