CtrlK
BlogDocsLog inGet started
Tessl Logo

gws-gmail-watch

Gmail: Watch for new emails and stream them as NDJSON.

Install with Tessl CLI

npx tessl i github:googleworkspace/cli --skill gws-gmail-watch
What are skills?

70

2.06x

Does it follow best practices?

Evaluation93%

2.06x

Agent success when using this skill

Validation for skill structure

SKILL.md
Review
Evals

gmail +watch

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

Watch for new emails and stream them as NDJSON

Usage

gws gmail +watch

Flags

FlagRequiredDefaultDescription
--projectGCP project ID for Pub/Sub resources
--subscriptionExisting Pub/Sub subscription name (skip setup)
--topicExisting Pub/Sub topic with Gmail push permission already granted
--label-idsComma-separated Gmail label IDs to filter (e.g., INBOX,UNREAD)
--max-messages10Max messages per pull batch
--poll-interval5Seconds between pulls
--msg-formatfullGmail message format: full, metadata, minimal, raw
--oncePull once and exit
--cleanupDelete created Pub/Sub resources on exit
--output-dirWrite each message to a separate JSON file in this directory

Examples

gws gmail +watch --project my-gcp-project
gws gmail +watch --project my-project --label-ids INBOX --once
gws gmail +watch --subscription projects/p/subscriptions/my-sub
gws gmail +watch --project my-project --cleanup --output-dir ./emails

Tips

  • Gmail watch expires after 7 days — re-run to renew.
  • Without --cleanup, Pub/Sub resources persist for reconnection.
  • Press Ctrl-C to stop gracefully.

See Also

  • gws-shared — Global flags and auth
  • gws-gmail — All send, read, and manage email commands
Repository
googleworkspace/cli
Last updated
Created

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.