Back to Commands

Gws Chat

Commands google-workspace 27
Install Command
npx claude-code-templates@latest --command google-workspace/gws-chat
View on GitHub

Content

Google Workspace Chat

Execute Google Workspace Chat operations: $ARGUMENTS

Prerequisites

  • Google Workspace CLI (gws) must be installed
  • Authentication configured: Run gws auth status to verify
  • Review gws chat --help for all available commands

Available Resources and Methods

chat (v1)

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

bash
gws chat <resource> <method> [flags]

Helper Commands

Command Description
+send Send a message to a space

API Resources

customEmojis

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 in Import 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 a 404 NOT_FOUND error. 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 the displayName field and receive the error message ALREADY_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, set use_admin_access to true. 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 appropriate membership.member.name. To add a human user, use users/{user}, where {user} can be the email address for the user.
  • members — Operations on the 'members' resource
  • messages — Operations on the 'messages' resource
  • spaceEvents — Operations on the 'spaceEvents' resource

users

  • spaces — Operations on the 'spaces' resource

Discovering Commands

Before calling any API method, inspect it:

bash
# 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.

Usage

bash
# List available resources and methods
gws chat --help

# Inspect method schema before calling
gws schema chat.<resource>.<method>

# Execute command with arguments
gws chat $ARGUMENTS

Task

Execute the requested Chat operation: $ARGUMENTS

  1. Verify Prerequisites

    • Check gws is installed: gws --version
    • Verify authentication: gws auth status
    • Review available commands: gws chat --help
  2. Inspect Method Schema

    • Before calling any method, inspect its parameters
    • Use gws schema to understand required fields
    • Review parameter types and constraints
  3. Execute Operation

    • Build command with appropriate flags
    • Use --params for query/path parameters
    • Use --json for request body
    • Handle pagination with --max-results or --page-token
  4. Error Handling

    • Check command output for errors
    • Review API quotas and rate limits
    • Handle authentication issues
    • Retry transient failures

License: Apache License 2.0 Source: Google Workspace CLI Original Skill: gws-chat

Stack Builder

0 components

Your stack is empty

Browse components and click the + button to add them to your stack for easy installation.