CLI Profile

Google Workspace CLI

Community CuratedGoogle Workspacev0.7.0

Dynamic CLI for Drive, Gmail, Calendar, Sheets, Chat, and the wider Google Workspace API surface

Install Matrix

Using cross-platform install guidance for macOS.

npm

sha256: b6ad82ccdd4ca69e52439f00336dc0c8050166b78acb71fcc291527fd70bed08

cargo

hash: unavailable

nix

hash: unavailable

Auth Guide

OAuthdrivegmail

Token refresh: Refresh access by rerunning gws auth login, exporting a new credentials file, or replacing GOOGLE_WORKSPACE_CLI_TOKEN with a fresh access token.

Step 1

Run the guided Google Cloud and OAuth bootstrap if gcloud is available

Step 2

Authenticate interactively and request only the Workspace scopes you need

Step 3

For CI or headless agents, export credentials or point the CLI at a credentials file

Command Map

Workspace Api Bootstrap

gws auth setup

Guided bootstrap for Google Cloud project, OAuth client, and Workspace auth prerequisites

Output: Interactiveworkspace-api-bootstrap

Example 1

Known errors: gcloud CLI not found; Access blocked; Quota project misconfigured

gws auth login

Authenticate the CLI with OAuth scopes for the Workspace services you plan to automate

Output: Plain textworkspace-api-bootstrap

--scopesoptional (string) - Comma-separated service scope preset such as drive,gmail,calendar

Example 1

Known errors: Access blocked; redirect_uri_mismatch; Too many scopes for unverified app

gws drive files list

List Google Drive files with structured JSON output and discovery-backed parameters

Output: JSONworkspace-api-bootstrap

--paramsoptional (json) - Google API parameter object encoded as JSON
--page-alloptional (boolean) - Paginate through all result pages as NDJSON

Example 1

Example 2

Known errors: accessNotConfigured; Insufficient OAuth scopes

gws sheets spreadsheets create

Create a new Google Sheet with a JSON request body

Output: Plain textworkspace-api-bootstrap

--jsonrequired (json) - Request body for the spreadsheet resource

Example 1

Known errors: Invalid JSON body; Sheets API not enabled

gws schema drive.files.list

Inspect the request and response schema for a discovery-backed API method before automating it

Output: Plain textworkspace-api-bootstrap

Example 1

Known errors: Unknown service; Unknown method

gws mcp

Start the built-in MCP server and expose selected Workspace services as tools

Output: Plain textworkspace-api-bootstrap

-s, --servicesoptional (string) - Comma-separated service list or all
-w, --workflowsoptional (boolean) - Expose workflow tools in addition to API tools

Example 1

Example 2

Known errors: No valid credentials found; Too many services for client tool limit

Workflow Recipes

Bootstrap Google Workspace Access

Install gws, complete OAuth setup, and verify Workspace API access before building automations.

1gws

Open workflow detail

Compatibility

Claude CodeUntestedEstimatedCodex CLI82%Gemini CLIUntestedEstimatedClineUntestedEstimatedAiderUntestedEstimatedOpenCodeUntestedEstimated

Requirements

Runtime: Standalone binary / package-managed CLI
Platforms: macOS, Linux, Windows (arm64, x86_64)
Approx. Size (estimated): ~33 MB

Permissions

Network: Yes
Filesystem: Read/Write
Credentials: GOOGLE_WORKSPACE_CLI_TOKEN, GOOGLE_WORKSPACE_CLI_CREDENTIALS_FILE, GOOGLE_WORKSPACE_CLI_CLIENT_ID, GOOGLE_WORKSPACE_CLI_CLIENT_SECRET, GOOGLE_WORKSPACE_PROJECT_ID
Ports: Not declared

Safe Execution

This CLI has broad system access. Recommended: run inside a container/sandbox.

Listing Stats

Queries/Week: 72.0
Trust Score: 84.0
Last Verified: 3/6/2026, 12:41:00 PM
Last Updated: 3/6/2026, 12:41:00 PM
Website: https://github.com/googleworkspace/cli

Version Feed

Version: #1
ID: lv_gws_1
Updated: 3/6/2026, 12:41:00 PM
Changes: identity, install, auth, commands

Report Issue

CLI Profile

Loading CLI profile...

Fetching install matrix, auth flow, command map, and compatibility data.

Please wait while clime prepares the listing details.