gws-keep
googleworkspace/cli
Manage Google Keep notes via CLI with create, delete, get, list, and permission operations.
What is gws-keep?
Interact with Google Keep notes programmatically through the Google Workspace CLI. Use this skill to create, retrieve, delete, and list notes, as well as manage note permissions and download attachments.
- Create new notes in Google Keep
- Delete notes (owner role required)
- Retrieve individual notes by ID
- List notes with pagination support
- Manage note permissions and collaborators
- Download note attachments in various MIME types
How to install gws-keep
npx skills add null --skill gws-keep- Google Workspace CLI (gws) installed and configured
- Authentication credentials set up via gws-shared SKILL.md
- Owner or appropriate permissions on notes to be modified
How to use gws-keep
- 1.Run `gws keep --help` to browse available resources and methods
- 2.Use `gws schema keep.<resource>.<method>` to inspect required parameters and types
- 3.Build commands with `gws keep <resource> <method> [flags]` using discovered parameters
- 4.Use `--params` or `--json` flags to pass method arguments
- 5.For paginated results, capture `next_page_token` and pass it to subsequent list calls
Use cases
- Automate note creation from external data sources
- Bulk delete or archive notes programmatically
- Retrieve note content for processing or backup
- List all notes with filtering and pagination
- Grant or revoke collaborator access to notes
- Google Workspace administrators
- Automation engineers building workflows
- Developers integrating Keep with other systems
- Teams managing shared note repositories
gws-keep FAQ
You must set up Google Workspace authentication through the gws-shared SKILL.md. Refer to that file for auth configuration and security rules.
No. You must have the OWNER role on a note to delete it. Deletion is immediate and cannot be undone.
The list method returns paginated results. Use the `next_page_token` from the response in subsequent requests to fetch additional pages.
The API supports multiple MIME types for attachment media. Use the alt=media query parameter and specify your desired MIME type in the request.
Run `gws schema keep.<resource>.<method>` to inspect the method's required parameters, types, and defaults before building your command.
Full instructions (SKILL.md)
Source of truth, from googleworkspace/cli.
name: gws-keep description: "Manage Google Keep notes." metadata: version: 0.22.5 openclaw: category: "productivity" requires: bins: - gws cliHelp: "gws keep --help"
keep (v1)
PREREQUISITE: Read
../gws-shared/SKILL.mdfor auth, global flags, and security rules. If missing, rungws generate-skillsto create it.
gws keep <resource> <method> [flags]
API Resources
media
download— Gets an attachment. To download attachment media via REST requires the alt=media query parameter. Returns a 400 bad request error if attachment media is not available in the requested MIME type.
notes
create— Creates a new note.delete— Deletes a note. Caller must have theOWNERrole on the note to delete. Deleting a note removes the resource immediately and cannot be undone. Any collaborators will lose access to the note.get— Gets a note.list— Lists notes. Every list call returns a page of results withpage_sizeas the upper bound of returned items. Apage_sizeof zero allows the server to choose the upper bound. The ListNotesResponse contains at mostpage_sizeentries. If there are more things left to list, it provides anext_page_tokenvalue. (Page tokens are opaque values.) To get the next page of results, copy the result'snext_page_tokeninto the next request'spage_token.permissions— Operations on the 'permissions' resource
Discovering Commands
Before calling any API method, inspect it:
# Browse resources and methods
gws keep --help
# Inspect a method's required params, types, and defaults
gws schema keep.<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.