wehub-resource-sync
101 lines
2.5 KiB
Markdown
101 lines
2.5 KiB
Markdown
---
|
|
allowed-tools: Bash, Read, Write, Edit
|
|
argument-hint: [resource] [method] [flags]
|
|
description: Google Docs: Append text to a document.
|
|
---
|
|
|
|
# Google Workspace Docs Write
|
|
|
|
Execute Google Workspace Docs Write operations: $ARGUMENTS
|
|
|
|
## Prerequisites
|
|
|
|
- Google Workspace CLI (`gws`) must be installed
|
|
- Authentication configured: Run `gws auth status` to verify
|
|
- Review `gws docs-write --help` for all available commands
|
|
|
|
## Available Resources and Methods
|
|
|
|
# docs +write
|
|
|
|
> **PREREQUISITE:** Read `../gws-shared/SKILL.md` for auth, global flags, and security rules. If missing, run `gws generate-skills` to create it.
|
|
|
|
Append text to a document
|
|
|
|
## Usage
|
|
|
|
```bash
|
|
gws docs +write --document <ID> --text <TEXT>
|
|
```
|
|
|
|
## Flags
|
|
|
|
| Flag | Required | Default | Description |
|
|
|------|----------|---------|-------------|
|
|
| `--document` | ✓ | — | Document ID |
|
|
| `--text` | ✓ | — | Text to append (plain text) |
|
|
|
|
## Examples
|
|
|
|
```bash
|
|
gws docs +write --document DOC_ID --text 'Hello, world!'
|
|
```
|
|
|
|
## Tips
|
|
|
|
- Text is inserted at the end of the document body.
|
|
- For rich formatting, use the raw batchUpdate API instead.
|
|
|
|
> [!CAUTION]
|
|
> This is a **write** command — confirm with the user before executing.
|
|
|
|
## See Also
|
|
|
|
- [gws-shared](../gws-shared/SKILL.md) — Global flags and auth
|
|
- [gws-docs](../gws-docs/SKILL.md) — All read and write google docs commands
|
|
|
|
## Usage
|
|
|
|
```bash
|
|
# List available resources and methods
|
|
gws docs-write --help
|
|
|
|
# Inspect method schema before calling
|
|
gws schema docs-write.<resource>.<method>
|
|
|
|
# Execute command with arguments
|
|
gws docs-write $ARGUMENTS
|
|
```
|
|
|
|
## Task
|
|
|
|
Execute the requested Docs Write operation: $ARGUMENTS
|
|
|
|
1. **Verify Prerequisites**
|
|
- Check `gws` is installed: `gws --version`
|
|
- Verify authentication: `gws auth status`
|
|
- Review available commands: `gws docs-write --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-write`
|