Skip to content

docs: fix gws setup → gws auth setup #60

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jpoehnelt merged 1 commit into from
Mar 4, 2026
Merged

docs: fix gws setup → gws auth setup #60

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/fix-setup-docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@googleworkspace/cli": patch
---

Fix docs: `gws setup` → `gws auth setup` (fixes #56, #57)
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ npm install -g @googleworkspace/cli
```bash
npm install -g @googleworkspace/cli

gws setup # walks you through Google Cloud project config + OAuth login
gws auth setup # walks you through Google Cloud project config + OAuth login
gws drive files list --params '{"pageSize": 5}'
```

Expand Down Expand Up @@ -92,15 +92,15 @@ The CLI supports multiple auth workflows so it works on your laptop, in CI, and
Credentials are encrypted at rest (AES-256-GCM) with the key stored in your OS keyring.

```bash
gws setup # one-time: creates a Cloud project, enables APIs, logs you in
gws auth setup # one-time: creates a Cloud project, enables APIs, logs you in
gws auth login # subsequent logins
```

> Requires the [`gcloud` CLI](https://cloud.google.com/sdk/docs/install) to be installed and authenticated.

### Manual OAuth setup (Google Cloud Console)

Use this when `gws setup` cannot automate project/client creation, or when you want explicit control.
Use this when `gws auth setup` cannot automate project/client creation, or when you want explicit control.

1. Open Google Cloud Console in the target project:
- OAuth consent screen: `https://console.cloud.google.com/apis/credentials/consent?project=<PROJECT_ID>`
Expand Down Expand Up @@ -210,7 +210,7 @@ The `gws-shared` skill includes an `install` block so OpenClaw auto-installs the

1. Authenticate the CLI first:
```bash
gws setup
gws auth setup
```

2. Install the extension into the Gemini CLI:
Expand Down Expand Up @@ -296,7 +296,7 @@ If a required Google API is not enabled for your GCP project, you will see a
3. Wait ~10 seconds, then retry your `gws` command.

> [!TIP]
> You can also run `gws setup` which walks you through enabling all required
> You can also run `gws auth setup` which walks you through enabling all required
> APIs for your project automatically.


Expand Down
Loading