gws-chat
googleworkspace/cli
Manage Google Chat spaces, messages, and custom emojis via CLI.
What is gws-chat?
Google Chat skill provides CLI access to Google Chat API resources including spaces, messages, media, and custom emojis. Use it to automate Chat operations like creating spaces, sending messages, managing members, and uploading attachments.
- Create, update, delete, and list Google Chat spaces
- Send messages and manage message resources within spaces
- Upload and download media attachments
- Create, delete, and manage custom emojis (Workspace accounts only)
- Find and manage direct message conversations
- Search and administer spaces with admin access
How to install gws-chat
npx skills add null --skill gws-chat- Google Workspace account with Chat enabled
- gws CLI installed and authenticated (see gws-shared/SKILL.md)
- Appropriate permissions for Chat API operations
How to use gws-chat
- 1.Run `gws chat --help` to browse available resources and methods
- 2.Use `gws schema chat.<resource>.<method>` to inspect required parameters and types
- 3.Build commands with `gws chat <resource> <method> [flags]` using discovered parameters
- 4.Use `--params` or `--json` flags to pass API parameters
- 5.For sending messages, use the `+send` helper command from gws-chat-send skill
Use cases
- Automate creation of Chat spaces for projects or teams
- Programmatically send notifications or alerts to Chat spaces
- Manage custom emoji libraries for organization branding
- Bulk import data into Chat spaces during migration
- Upload files and media as attachments to messages
- Google Workspace administrators
- Automation engineers building Chat workflows
- Teams automating internal communications
- Organizations migrating to Google Chat
gws-chat FAQ
Authentication is configured in gws-shared/SKILL.md. Ensure you have a valid Google Workspace account and appropriate Chat API permissions.
Yes, use the `+send` helper command from the gws-chat-send skill for sending messages, or call the messages resource directly.
No, custom emojis are only available for Google Workspace accounts and require the administrator to enable them for the organization.
Run `gws chat --help` to browse resources and methods, then use `gws schema chat.<resource>.<method>` to inspect parameters.
Yes, the skill provides access to the members resource under spaces for managing space memberships.
Full instructions (SKILL.md)
Source of truth, from googleworkspace/cli.
name: gws-chat description: "Google Chat: Manage Chat spaces and messages." metadata: version: 0.22.5 openclaw: category: "productivity" requires: bins: - gws cliHelp: "gws chat --help"
chat (v1)
PREREQUISITE: Read
../gws-shared/SKILL.mdfor auth, global flags, and security rules. If missing, rungws generate-skillsto create it.
gws chat <resource> <method> [flags]
Helper Commands
| Command | Description |
|---|---|
+send | Send a message to a space |
API Resources
customEmojis
create— Creates a custom emoji. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see Learn about custom emojis in Google Chat and Manage custom emoji permissions.delete— Deletes a custom emoji. By default, users can only delete custom emoji they created. Emoji managers assigned by the administrator can delete any custom emoji in the organization. See Learn about custom emojis in Google Chat. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization.get— Returns details about a custom emoji. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see Learn about custom emojis in Google Chat and Manage custom emoji permissions.list— Lists custom emojis visible to the authenticated user. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see Learn about custom emojis in Google Chat and Manage custom emoji permissions.
media
download— Downloads media. Download is supported on the URI/v1/media/{+name}?alt=media.upload— Uploads an attachment. For an example, see Upload media as a file attachment.
spaces
completeImport— Completes the import process for the specified space and makes it visible to users.create— Creates a space. Can be used to create a named space, or a group chat inImport mode. For an example, see Create a space.delete— Deletes a named space. Always performs a cascading delete, which means that the space's child resources—like messages posted in the space and memberships in the space—are also deleted. For an example, see Delete a space.findDirectMessage— Returns the existing direct message with the specified user. If no direct message space is found, returns a404 NOT_FOUNDerror. For an example, see Find a direct message. With app authentication, returns the direct message space between the specified user and the calling Chat app.get— Returns details about a space. For an example, see Get details about a space.list— Lists spaces the caller is a member of. Group chats and DMs aren't listed until the first message is sent. For an example, see List spaces.patch— Updates a space. For an example, see Update a space. If you're updating thedisplayNamefield and receive the error messageALREADY_EXISTS, try a different display name.. An existing space within the Google Workspace organization might already use this display name.search— Returns a list of spaces in a Google Workspace organization based on an administrator's search. In the request, setuse_admin_accesstotrue. For an example, see Search for and manage spaces.setup— Creates a space and adds specified users to it. The calling user is automatically added to the space, and shouldn't be specified as a membership in the request. For an example, see Set up a space with initial members. To specify the human members to add, add memberships with the appropriatemembership.member.name. To add a human user, useusers/{user}, where{user}can be the email address for the user.members— Operations on the 'members' resourcemessages— Operations on the 'messages' resourcespaceEvents— Operations on the 'spaceEvents' resource
users
sections— Operations on the 'sections' resourcespaces— Operations on the 'spaces' resource
Discovering Commands
Before calling any API method, inspect it:
# Browse resources and methods
gws chat --help
# Inspect a method's required params, types, and defaults
gws schema chat.<resource>.<method>
Use gws schema output to build your --params and --json flags.
Related skills
More from googleworkspace/cli and the wider catalog.
gws-gmail
Send, read, and manage Gmail emails via Google Workspace CLI.
gws-drive
Manage Google Drive files, folders, and shared drives via CLI.
gws-docs
Read and write Google Docs via command line.
gws-calendar
Manage Google Calendar events, calendars, and access control via CLI.
gws-sheets
Read and write Google Sheets spreadsheets via CLI.
gws-gmail-send
Send emails via Gmail with attachments, CC/BCC, HTML support, and draft options.