wehub-resource-sync
99 lines
2.9 KiB
Markdown
99 lines
2.9 KiB
Markdown
---
|
|
allowed-tools: Bash, Read, Write, Edit
|
|
argument-hint: [resource] [method] [flags]
|
|
description: Read and write Google Docs.
|
|
---
|
|
|
|
# Google Workspace Docs
|
|
|
|
Execute Google Workspace Docs operations: $ARGUMENTS
|
|
|
|
## Prerequisites
|
|
|
|
- Google Workspace CLI (`gws`) must be installed
|
|
- Authentication configured: Run `gws auth status` to verify
|
|
- Review `gws docs --help` for all available commands
|
|
|
|
## Available Resources and Methods
|
|
|
|
# docs (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 docs <resource> <method> [flags]
|
|
```
|
|
|
|
## Helper Commands
|
|
|
|
| Command | Description |
|
|
|---------|-------------|
|
|
| [`+write`](../gws-docs-write/SKILL.md) | Append text to a document |
|
|
|
|
## API Resources
|
|
|
|
### documents
|
|
|
|
- `batchUpdate` — Applies one or more updates to the document. 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. Other requests do not need to return information; these each return an empty reply. The order of replies matches that of the requests.
|
|
- `create` — Creates a blank document using the title given in the request. Other fields in the request, including any provided content, are ignored. Returns the created document.
|
|
- `get` — Gets the latest version of the specified document.
|
|
|
|
## Discovering Commands
|
|
|
|
Before calling any API method, inspect it:
|
|
|
|
```bash
|
|
# Browse resources and methods
|
|
gws docs --help
|
|
|
|
# Inspect a method's required params, types, and defaults
|
|
gws schema docs.<resource>.<method>
|
|
```
|
|
|
|
Use `gws schema` output to build your `--params` and `--json` flags.
|
|
|
|
## Usage
|
|
|
|
```bash
|
|
# List available resources and methods
|
|
gws docs --help
|
|
|
|
# Inspect method schema before calling
|
|
gws schema docs.<resource>.<method>
|
|
|
|
# Execute command with arguments
|
|
gws docs $ARGUMENTS
|
|
```
|
|
|
|
## Task
|
|
|
|
Execute the requested Docs operation: $ARGUMENTS
|
|
|
|
1. **Verify Prerequisites**
|
|
- Check `gws` is installed: `gws --version`
|
|
- Verify authentication: `gws auth status`
|
|
- Review available commands: `gws docs --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](https://github.com/googleworkspace/cli)
|
|
**Original Skill**: `gws-docs`
|