cli  by googleworkspace

Unified CLI for Google Workspace with AI agent integration

Created 5 days ago

New!

14,539 stars

Top 3.4% on SourcePulse

GitHubView on GitHub
Project Summary

A command-line interface (CLI) designed to provide unified access to all Google Workspace APIs, including Drive, Gmail, Calendar, Sheets, Docs, and Chat. It targets developers and AI agents needing to programmatically interact with Google Workspace, offering zero-boilerplate commands, structured JSON output, and integrated AI agent capabilities for simplified automation and management.

How It Works

The CLI dynamically builds its command surface at runtime by querying Google's own Discovery Service. This approach ensures that as soon as Google adds new API endpoints or methods, gws automatically incorporates them, eliminating the need for manual updates or static command lists. This design prioritizes staying current with the rapidly evolving Google Workspace API landscape.

Quick Start & Requirements

  • Installation: npm install -g @googleworkspace/cli. Pre-built binaries are available on GitHub Releases, or it can be built from source using cargo install --path . or Nix.
  • Prerequisites: Node.js 18+ (for npm), a Google Cloud project, and a Google account with Workspace access.
  • Setup: Run gws auth setup to configure OAuth credentials and gws auth login for subsequent authentication.
  • Docs: The README serves as primary documentation; specific links for demos or roadmaps are not provided.

Highlighted Details

  • Features 40+ built-in AI agent skills and supports installing more via npx skills add.
  • Provides structured JSON output for all operations, ideal for programmatic consumption and AI agents.
  • Includes an MCP (Model Context Protocol) server (gws mcp) to expose Workspace APIs as tools for AI clients like Gemini CLI or Claude Desktop.
  • Supports advanced authentication workflows, including service accounts and domain-wide delegation.
  • Offers features like auto-pagination, --dry-run for request preview, and Model Armor integration for response sanitization.

Maintenance & Community

The project is under active development, with an explicit warning about potential breaking changes leading up to v1.0. No specific community channels (like Discord or Slack) or notable contributors are listed beyond the repository itself.

Licensing & Compatibility

The project is licensed under the Apache-2.0 license, which is permissive and generally compatible with commercial use and closed-source linking.

Limitations & Caveats

This is not an officially supported Google product. The project is in active development, and users should anticipate breaking changes. Unverified OAuth applications (in testing mode) have scope limitations, potentially requiring manual scope selection during authentication.

Health Check
Last Commit

1 day ago

Responsiveness

Inactive

Pull Requests (30d)
163
Issues (30d)
118
Star History
14,624 stars in the last 5 days

Explore Similar Projects

Feedback? Help us improve.