Skip to content

Commit 58b4db4

Browse files
committed
docs: expand oauth setup instructions
1 parent 5741aee commit 58b4db4

File tree

1 file changed

+21
-5
lines changed

1 file changed

+21
-5
lines changed

README.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,27 @@ Run:
2323

2424
## Setup (OAuth)
2525

26-
1. Create OAuth credentials in Google Cloud Console (Desktop app) and enable the APIs you need.
27-
2. Store the downloaded client JSON:
28-
- `gog auth credentials ~/path/to/credentials.json`
29-
3. Authorize your account (refresh token stored in OS keychain via `github.com/99designs/keyring`):
30-
- `gog auth add you@gmail.com`
26+
Before adding an account you need OAuth2 credentials from Google Cloud Console:
27+
28+
1. Create a project (or select an existing one): https://console.cloud.google.com/projectcreate
29+
2. Enable the APIs you need:
30+
- Gmail API: https://console.cloud.google.com/apis/api/gmail.googleapis.com
31+
- Google Calendar API: https://console.cloud.google.com/apis/api/calendar-json.googleapis.com
32+
- Google Drive API: https://console.cloud.google.com/apis/api/drive.googleapis.com
33+
- People API (Contacts): https://console.cloud.google.com/apis/api/people.googleapis.com
34+
3. Set app name / branding (OAuth consent screen): https://console.cloud.google.com/auth/branding
35+
4. If your app is in “Testing”, add test users (all Google accounts you’ll use with `gog`): https://console.cloud.google.com/auth/audience
36+
5. Create an OAuth client: https://console.cloud.google.com/auth/clients
37+
- Click “Create Client”
38+
- Application type: “Desktop app”
39+
- Download the JSON file (usually named like `client_secret_....apps.googleusercontent.com.json`)
40+
41+
Then:
42+
43+
- Store the downloaded client JSON (no renaming required):
44+
- `gog auth credentials ~/Downloads/client_secret_....json`
45+
- Authorize your account (refresh token stored in OS keychain via `github.com/99designs/keyring`):
46+
- `gog auth add you@gmail.com`
3147

3248
Notes:
3349

0 commit comments

Comments
 (0)