Skip to main content

gws-sheets: Read and write Google Sheets

Read, create, and update Google Sheets spreadsheets and append rows using command-line tools.

Source facts

Repository
googleworkspace/cli
Last source activity
March 31, 2026 at 18:32
Detected SKILL.md language
English
Stars
32,125
Forks
1,987

Uses

gws sheets [flags]

Prerequisites

Node.js 18+ and gws CLI installed with authentication configured.

How to use

Review authentication and global flags in the shared skill guide before running commands.

Install options

The review-first prompt is selected by default. You can switch to a direct command or download a local copy.

Review the source files

Read SKILL.md and any companion files shown by SkillsMP before deciding whether to install.

Showing SKILL.md

SKILL.md
Source instructions · Read-only preview
name
gws-sheets
description
Google Sheets: Read and write spreadsheets.
metadata
{"version":"0.22.5","openclaw":{"category":"productivity","requires":{"bins":"[Truncated]"},"cliHelp":"gws sheets --help"}}
# sheets (v4) > **PREREQUISITE:** Read `../gws-shared/SKILL.md` for auth, global flags, and security rules. If missing, run `gws generate-skills` to create it. ```bash gws sheets <resource> <method> [flags] ``` ## Helper Commands | Command | Description | |---------|-------------| | [`+append`](../gws-sheets-append/SKILL.md) | Append a row to a spreadsheet | | [`+read`](../gws-sheets-read/SKILL.md) | 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](https://developers.google.com/workspace/sheets/api/guides/field-masks) listing your desired fields using the `fields` URL 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](https://developers.google.com/workspace/sheets/api/guides/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' resource - `sheets` — Operations on the 'sheets' resource - `values` — Operations on the 'values' resource ## Discovering Commands Before calling any API method, inspect it: ```bash # 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.
View on GitHub