workspace-cli

README

gws

Unified CLI for Google Workspace — Gmail, Calendar, Drive, Docs, Sheets, Slides, Tasks, and more from your terminal.

gws gives developers and AI agents a structured, token-efficient interface to 10+ Google Workspace services. Every command returns consistent JSON (or human-readable text), making it ideal for scripting, automation, and agent toolchains.

Built for AI & automation: Drop gws into Claude Code, Codex, or shell scripts and they inherit structured output, predictable flags, and safe defaults — no wrapper code required.

Features

• 10+ Google services — Gmail, Calendar, Drive, Docs, Sheets, Slides, Tasks, Chat, Forms, Custom Search.
• Scriptable output — --format json (default) or --format text for human-readable tables.
• OAuth2 + PKCE — Secure browser-based auth with automatic token refresh and 0600 file permissions.
• Single auth flow — Authenticate once to access all services; all scopes requested upfront.
• Lazy clients — Service clients are initialized on-demand with mutex protection.

Installation

Go Install

go install github.com/omriariav/workspace-cli/cmd/gws@latest

From Source

git clone https://github.com/omriariav/workspace-cli.git
cd workspace-cli
make build    # produces ./bin/gws
./bin/gws --help

Prerequisites

1. A Google Cloud Project with an OAuth 2.0 Client ID (Desktop type).
2. Enable the APIs you need in the API Library:
   • Gmail, Calendar, Drive, Docs, Sheets, Slides, Tasks (core)
   • Chat, Forms (optional — require additional setup)

Quickstart

1. Configure credentials

export GWS_CLIENT_ID="your-client-id.apps.googleusercontent.com"
export GWS_CLIENT_SECRET="your-client-secret"

Or create ~/.config/gws/config.yaml:

client_id: "your-client-id.apps.googleusercontent.com"
client_secret: "your-client-secret"

2. Authenticate

gws auth login          # Opens browser for OAuth consent
gws auth status         # Verify: shows email and token expiry

3. Use it

gws gmail list --max 5 --query "is:unread"
gws calendar events --days 7
gws drive search "quarterly report" --max 10
gws docs read <document-id>
gws sheets read <spreadsheet-id> "Sheet1!A1:D10"
gws tasks lists

Add --format text to any command for human-readable output.

Commands

Auth

Command	Description
gws auth login	Authenticate via OAuth2 + PKCE
gws auth status	Show current auth status and email
gws auth logout	Remove stored credentials

Gmail

Command	Description
gws gmail list	List threads (--max, --query)
gws gmail read <id>	Read message body and headers
gws gmail send	Send email (--to, --subject, --body, --cc, --bcc)

Calendar

Command	Description
gws calendar list	List all calendars
gws calendar events	List upcoming events (--days, --calendar-id, --max)
gws calendar create	Create event (--title, --start, --end, --attendees)

Tasks

Command	Description
gws tasks lists	List task lists
gws tasks list <id>	List tasks in a list (--show-completed)
gws tasks create	Create task (--title, --tasklist, --due)
gws tasks complete <list> <task>	Mark task as done

Drive

Command	Description
gws drive list	List files (--folder, --max, --order)
gws drive search <query>	Full-text search
gws drive info <id>	File metadata, owners, permissions
gws drive download <id>	Download file (--output); auto-exports Google formats
gws drive comments <id>	List comments and replies (--include-resolved, --include-deleted)

Docs

Command	Description
gws docs read <id>	Extract document text (--include-formatting)
gws docs info <id>	Document metadata and styles
gws docs create	Create new document (--title, --text)
gws docs append <id>	Append text to document (--text, --newline)

Sheets

Command	Description
gws sheets info <id>	Spreadsheet metadata
gws sheets list <id>	List sheets in a spreadsheet
gws sheets read <id> <range>	Read cell values (--output-format=csv, --headers)

Slides

Command	Description
gws slides info <id>	Presentation metadata
gws slides list <id>	List slides with text content
gws slides read <id> [n]	Read slide text (specific or all)
gws slides create	Create new presentation (--title)
gws slides add-slide <id>	Add slide (--title, --body, --layout)

Chat

Requires Chat App configuration in Google Cloud Console.

Command	Description
gws chat list	List spaces
gws chat messages <space>	List messages in a space
gws chat send	Send message (--space, --text)

Forms

Requires enabling the Google Forms API.

Command	Description
gws forms info <id>	Form structure and questions
gws forms responses <id>	All form responses with answers

Custom Search

Requires a Programmable Search Engine ID and API key.

Command	Description
gws search <query>	Search the web (--max, --site, --type)

Structured Output

Every command returns JSON by default for machine consumption:

$ gws calendar events --days 1
{
  "count": 3,
  "events": [
    {"id": "abc123", "summary": "Team standup", "start": "2024-01-15T09:00:00Z"},
    ...
  ]
}

Development

Project Layout

cmd/              # Cobra command implementations
internal/
  auth/           # OAuth2 + PKCE flow, token management
  client/         # Lazy-initialized Google API service factory
  config/         # Viper configuration and path resolution
  printer/        # JSON and text output formatters
main.go           # Entry point

Building & Testing

make build      # Build binary to ./bin/gws
make test       # Run unit tests
make test-race  # Run tests with race detector
make vet        # Static analysis
make fmt        # Format code
make tidy       # Tidy go modules

Credential Storage

File	Permissions	Contents
~/.config/gws/config.yaml	0600	OAuth client ID/secret, preferences
~/.config/gws/token.json	0600	OAuth access/refresh tokens

Note: After upgrading gws to a version with new features (e.g., Docs/Slides write commands), you may need to re-authenticate to grant the new OAuth scopes:

gws auth logout && gws auth login

License

gws is available under the MIT License.