gws-sheets
googleworkspace/cli
Read and write Google Sheets spreadsheets via CLI.
What is gws-sheets?
Google Sheets skill provides command-line access to the Sheets API v4 for reading, writing, and updating spreadsheet data. Use it when you need to automate spreadsheet operations or integrate sheet data into workflows.
- Read values from spreadsheets
- Append rows to spreadsheets
- Create new spreadsheets
- Apply batch updates to spreadsheets
- Retrieve spreadsheet metadata and grid data
- Access developer metadata and sheet resources
How to install gws-sheets
npx skills add null --skill gws-sheets- Google Workspace CLI (gws) installed
- gws-shared skill installed for authentication
- Valid Google Workspace credentials configured
How to use gws-sheets
- 1.Run `gws sheets --help` to browse available resources and methods
- 2.Use `gws schema sheets.<resource>.<method>` to inspect required parameters and types
- 3.Build your command with appropriate `--params` and `--json` flags based on schema output
- 4.Execute `gws sheets <resource> <method> [flags]` with your parameters
- 5.Use helper commands `gws sheets +read` to read values or `gws sheets +append` to append rows for common operations
Use cases
- Automate data entry by appending rows to tracking sheets
- Extract data from spreadsheets for processing or analysis
- Create new spreadsheets programmatically
- Perform bulk updates across multiple cells or ranges
- Integrate spreadsheet data into agent workflows
- Automation engineers
- Data analysts
- Workflow developers
- Anyone automating spreadsheet operations
gws-sheets FAQ
Authentication is handled by the gws-shared skill. Ensure you have valid Google Workspace credentials configured and have run `gws generate-skills` if gws-shared is missing.
Run `gws sheets --help` to browse resources and methods, then use `gws schema sheets.<resource>.<method>` to inspect specific method parameters.
Yes, use the helper commands: `gws sheets +read` to read values and `gws sheets +append` to append rows to a spreadsheet.
batchUpdate applies one or more updates to a spreadsheet. Each request is validated before being applied; if any request is invalid, the entire request fails and nothing is applied.
Full instructions (SKILL.md)
Source of truth, from googleworkspace/cli.
name: gws-sheets description: "Google Sheets: Read and write spreadsheets." metadata: version: 0.22.5 openclaw: category: "productivity" requires: bins: - gws cliHelp: "gws sheets --help"
sheets (v4)
PREREQUISITE: Read
../gws-shared/SKILL.mdfor auth, global flags, and security rules. If missing, rungws generate-skillsto create it.
gws sheets <resource> <method> [flags]
Helper Commands
| Command | Description |
|---|---|
+append | Append a row to a spreadsheet |
+read | Read values from a spreadsheet |
API Resources
spreadsheets
batchUpdate— Applies one or more updates to the spreadsheet. Each request is validated before being applied. If any request is not valid then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. The replies will mirror the requests. For example, if you applied 4 updates and the 3rd one had a reply, then the response will have 2 empty replies, the actual reply, and another empty reply, in that order.create— Creates a spreadsheet, returning the newly created spreadsheet.get— Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. By default, data within grids is not returned. You can include grid data in one of 2 ways: * Specify a field mask listing your desired fields using thefieldsURL parameter in HTTP * Set the includeGridData URL parameter to true.getByDataFilter— Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. For more information, see Read, write, and search metadata. This method differs from GetSpreadsheet in that it allows selecting which subsets of spreadsheet data to return by specifying a dataFilters parameter. Multiple DataFilters can be specified.developerMetadata— Operations on the 'developerMetadata' resourcesheets— Operations on the 'sheets' resourcevalues— Operations on the 'values' resource
Discovering Commands
Before calling any API method, inspect it:
# Browse resources and methods
gws sheets --help
# Inspect a method's required params, types, and defaults
gws schema sheets.<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-gmail-send
Send emails via Gmail with attachments, CC/BCC, HTML support, and draft options.
gws-docs-write
Append plain text to the end of a Google Docs document.