googleworkspace/cli

gws-events-subscribe

Google Workspace Events: Subscribe to Workspace events and stream them as NDJSON.

View source

How to use

  1. Copy the installation command and review the source package before installing it in your own agent environment.
  2. Check the source document for required tools, credentials and supported hosts.
  3. Describe your input and desired deliverable; review the output against the source material.
npx skills add https://github.com/googleworkspace/cli --skill gws-events-subscribe

Before you start

  • Installation does not include a model subscription, API allowance or permission to access your files.
  • Repository stars and installation counts describe activity, not an independent quality or security test.
Original skill document

Rendered from the source repository. Headings, examples, code, tables, links, and referenced images are preserved.

events +subscribe

PREREQUISITE: Read ../gws-shared/SKILL.md for auth, global flags, and security rules. If missing, run gws generate-skills to create it.

Subscribe to Workspace events and stream them as NDJSON

Usage

bash
gws events +subscribe

Flags

FlagRequiredDefaultDescription
--target——Workspace resource URI (e.g., //chat.googleapis.com/spaces/SPACE_ID)
--event-types——Comma-separated CloudEvents types to subscribe to
--project——GCP project ID for Pub/Sub resources
--subscription——Existing Pub/Sub subscription name (skip setup)
--max-messages—10Max messages per pull batch (default: 10)
--poll-interval—5Seconds between pulls (default: 5)
--once——Pull once and exit
--cleanup——Delete created Pub/Sub resources on exit
--no-ack——Don't auto-acknowledge messages
--output-dir——Write each event to a separate JSON file in this directory

Examples

bash
gws events +subscribe --target '//chat.googleapis.com/spaces/SPACE' --event-types 'google.workspace.chat.message.v1.created' --project my-project
gws events +subscribe --subscription projects/p/subscriptions/my-sub --once
gws events +subscribe ... --cleanup --output-dir ./events

Tips

  • Without --cleanup, Pub/Sub resources persist for reconnection.
  • Press Ctrl-C to stop gracefully.
[!CAUTION] This is a write command — confirm with the user before executing.

See Also

  • gws-shared — Global flags and auth
  • gws-events — All subscribe to google workspace events commands

Related by task

from this repository

More skills

All skills