Install
Use with your agent
Install the gws-gmail skill, then use it as build context. Run: npx skills add https://github.com/googleworkspace/cli --skill gws-gmail. Then read the installed skill.md and follow its guidance to build or refactor my project.
gmail (v1)
PREREQUISITE: Read
../gws-shared/SKILL.mdfor auth, global flags, and security rules. If missing, rungws generate-skillsto create it.
gws gmail <resource> <method> [flags]
Helper Commands
| Command | Description |
|---|---|
+send | Send an email |
+triage | Show unread inbox summary (sender, subject, date) |
+reply | Reply to a message (handles threading automatically) |
+reply-all | Reply-all to a message (handles threading automatically) |
+forward | Forward a message to new recipients |
+read | Read a message and extract its body or headers |
+watch | Watch for new emails and stream them as NDJSON |
API Resources
users
getProfile— Gets the current user's Gmail profile.stop— Stop receiving push notifications for the given user mailbox.watch— Set up or update a push notification watch on the given user mailbox.drafts— Operations on the 'drafts' resourcehistory— Operations on the 'history' resourcelabels— Operations on the 'labels' resourcemessages— Operations on the 'messages' resourcesettings— Operations on the 'settings' resourcethreads— Operations on the 'threads' resource
Discovering Commands
Before calling any API method, inspect it:
# Browse resources and methods
gws gmail --help
# Inspect a method's required params, types, and defaults
gws schema gmail.<resource>.<method>
Use gws schema output to build your --params and --json flags.