{"schemaVersion":"opencli.cli.v1","slug":"gws","name":"Google Workspace CLI","shortName":"gws","binaryName":"gws","maker":{"slug":"google","name":"Google","type":"org","url":"https://google.com","officialPlatformMaker":true,"featuredBuilder":false},"category":"Productivity","description":"The official CLI from Google. Drive, Gmail, Calendar, Sheets, and Chat from one official CLI. Start with `gws auth setup` and go from there. Supports structured output — good for scripts and agents.","tagline":"Drive, Gmail, Calendar, Sheets, and Chat from one official CLI.","install":{"packageManager":"brew","command":"brew install googleworkspace-cli","packageName":null,"npmPackage":"@googleworkspace/cli","brewFormula":"googleworkspace-cli","brewCask":null,"crateName":null,"pypiPackage":null,"goPackage":null,"dockerImage":null},"verify":{"command":"gws --help","signal":"gws responds locally; authenticate before real work."},"quickStart":"gws auth setup","exampleWorkflow":["gws auth setup","gws gmail users messages list --params '{\"userId\": \"me\", \"q\": \"is:unread newer_than:7d\", \"maxResults\": 5}'","gws calendar events list --params '{\"calendarId\": \"primary\", \"maxResults\": 5}' --dry-run"],"agent":{"readiness":{"label":"Great for agents","score":90,"reasons":["Structured output is available for parsing.","Supports non-interactive/scripted use.","Dry-run or preview mode can reduce risk.","Works well in CI or repeatable automation."],"guardrails":["Verify identity/account before running task commands.","Network access is required; avoid leaking secrets in logs.","Start read-only, then ask before mutations."]},"packUrl":"https://opencli.co/cli/gws/agent.md","packMarkdown":"# OpenCLI Agent Pack: Google Workspace CLI\n\nUse this when an AI agent needs to work with `gws`.\n\n## What this CLI is for\nThe official CLI from Google. Drive, Gmail, Calendar, Sheets, and Chat from one official CLI. Start with `gws auth setup` and go from there. Supports structured output — good for scripts and agents.\n\nBest for: Searching Google Workspace mail, files, and calendars from the terminal or an agent.\n\n## Agent readiness\nGreat for agents (90/100)\n- Structured output is available for parsing.\n- Supports non-interactive/scripted use.\n- Dry-run or preview mode can reduce risk.\n- Works well in CI or repeatable automation.\n\n## Install\n```sh\nbrew install googleworkspace-cli\n```\n\n## Verify before real work\n```sh\ngws --help\n```\nExpected signal: gws responds locally; authenticate before real work.\n\n## Safe starting commands\n```sh\ngws --help\n```\n\n```sh\ngws auth setup\n```\n\n```sh\ngws gmail users messages list --params '{\"userId\": \"me\", \"q\": \"is:unread newer_than:7d\", \"maxResults\": 5}'\n```\n\n```sh\ngws calendar events list --params '{\"calendarId\": \"primary\", \"maxResults\": 5}' --dry-run\n```\n\n## Guardrails for agents\n- Verify identity/account before running task commands.\n- Network access is required; avoid leaking secrets in logs.\n- Start read-only, then ask before mutations.\n\n## Suggested agent instruction\nYou may use Google Workspace CLI (`gws`) for searching google workspace mail, files, and calendars from the terminal or an agent.. First install it if missing, then run the verify command. Start with read-only or inspection commands. Summarize what you found before changing anything. Ask for confirmation before commands that mutate remote state, spend money, deploy, delete data, merge code, or expose secrets.\n\nSource: OpenCLI\n"},"fit":{"bestFor":"Searching Google Workspace mail, files, and calendars from the terminal or an agent.","useThisIf":"You live in Google Workspace and want an agent to search Gmail or Calendar without IMAP hacks.","skipIf":"You're not on Google Workspace or cannot complete Google Cloud OAuth.","whatHappensNext":"Run `gws gmail users messages list --params '{\"userId\": \"me\", \"q\": \"is:unread newer_than:7d\", \"maxResults\": 5}'` to see it in action."},"capabilities":{"agentFriendly":true,"supportsJsonOutput":true,"supportsNonInteractive":true,"supportsDryRun":true,"requiresAuth":true,"requiresNetwork":true,"ciFriendly":true,"localFirst":false,"destructivePotential":"medium"},"taxonomy":{"useCases":["Gmail search","Calendar","Drive files","Sheets"],"aliases":["google workspace cli","gmail cli"],"keywords":["gmail calendar drive sheets workspace google"],"tags":["official","agent-friendly","json-output","dry-run"]},"links":{"website":"https://github.com/googleworkspace/cli","github":"https://github.com/googleworkspace/cli","docs":"https://github.com/googleworkspace/cli","opencli":"https://opencli.co/cli/gws","markdown":"https://opencli.co/cli/gws/agent.md","json":"https://opencli.co/cli/gws.json"},"metrics":{"githubStars":30993,"latestRelease":"2026-03-31T18:53:24Z","license":"Apache-2.0","metricLabel":null,"metricValue":null,"metricSource":null,"metricAsOf":"2026-09-14"}}