gws-shared

1# gws — Shared Reference
2 
3## Installation
4 
5The `gws` binary must be on `$PATH`. See the project README for install options.
6 
7## Authentication
8 
9```bash
10# Browser-based OAuth (interactive)
11gws auth login
12 
13# Service Account
14export GOOGLE_APPLICATION_CREDENTIALS=/path/to/key.json
15```
16 
17## Global Flags
18 
19| Flag | Description |
20|------|-------------|
21| `--format <FORMAT>` | Output format: `json` (default), `table`, `yaml`, `csv` |
22| `--dry-run` | Validate locally without calling the API |
23| `--sanitize <TEMPLATE>` | Screen responses through Model Armor |
24 
25## CLI Syntax
26 
27```bash
28gws <service> <resource> [sub-resource] <method> [flags]
29```
30 
31### Method Flags
32 
33| Flag | Description |
34|------|-------------|
35| `--params '{"key": "val"}'` | URL/query parameters |
36| `--json '{"key": "val"}'` | Request body |
37| `-o, --output <PATH>` | Save binary responses to file |
38| `--upload <PATH>` | Upload file content (multipart) |
39| `--page-all` | Auto-paginate (NDJSON output) |
40| `--page-limit <N>` | Max pages when using --page-all (default: 10) |
41| `--page-delay <MS>` | Delay between pages in ms (default: 100) |
42 
43## Security Rules
44 
45- **Never** output secrets (API keys, tokens) directly
46- **Always** confirm with user before executing write/delete commands
47- Prefer `--dry-run` for destructive operations
48- Use `--sanitize` for PII/content safety screening
49 
50## Shell Tips
51…