Skip to content

Commit a55d279

Browse files
committed
docs(readme): add Windows-native usage and compatibility status
1 parent 3415538 commit a55d279

File tree

2 files changed

+38
-0
lines changed

2 files changed

+38
-0
lines changed

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,12 @@ cd gogcli
5454
make
5555
```
5656

57+
Windows (PowerShell, no Make/bash required):
58+
59+
```powershell
60+
go build -o .\bin\gog.exe .\cmd\gog
61+
```
62+
5763
Run:
5864

5965
```bash
@@ -107,6 +113,12 @@ Before adding an account, create OAuth2 credentials from Google Cloud Console:
107113
gog auth credentials ~/Downloads/client_secret_....json
108114
```
109115

116+
Windows PowerShell:
117+
118+
```powershell
119+
.\bin\gog.exe auth credentials "C:\path\to\client_secret_....json"
120+
```
121+
110122
For multiple OAuth clients/projects:
111123

112124
```bash
@@ -120,6 +132,12 @@ gog auth credentials list
120132
gog auth add you@gmail.com
121133
```
122134

135+
Windows PowerShell:
136+
137+
```powershell
138+
.\bin\gog.exe auth add you@gmail.com
139+
```
140+
123141
This will open a browser window for OAuth authorization. The refresh token is stored securely in your system keychain.
124142

125143
Headless / remote server flows (no browser on the server):
@@ -175,6 +193,13 @@ export GOG_ACCOUNT=you@gmail.com
175193
gog gmail labels list
176194
```
177195

196+
Windows PowerShell:
197+
198+
```powershell
199+
$env:GOG_ACCOUNT = "you@gmail.com"
200+
.\bin\gog.exe gmail labels list
201+
```
202+
178203
## Authentication & Secrets
179204

180205
### Accounts and tokens
@@ -557,6 +582,7 @@ Options:
557582
- **Never commit OAuth client credentials** to version control
558583
- Store client credentials outside your project directory
559584
- Use different OAuth clients for development and production
585+
- Rotate the OAuth client secret immediately if it is ever shared or exposed
560586
- Re-authorize with `--force-consent` if you suspect token compromise
561587
- Remove unused accounts with `gog auth remove <email>`
562588

@@ -1677,6 +1703,13 @@ Go test wrapper (opt-in):
16771703
GOG_LIVE=1 go test -tags=integration ./internal/integration -run Live
16781704
```
16791705

1706+
Windows PowerShell:
1707+
1708+
```powershell
1709+
$env:GOG_LIVE = "1"
1710+
go test -tags=integration ./internal/integration -run Live
1711+
```
1712+
16801713
Optional env:
16811714
- `GOG_LIVE_FAST=1`
16821715
- `GOG_LIVE_SKIP=groups,keep`

docs/refactor/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,11 @@ Shipped (today)
1212
- `exports.md`: Drive-backed export command pattern (`docs|slides|sheets`).
1313
- `output.md`: shared table + paging helpers.
1414
- `templates.md`: googleauth HTML templates via `//go:embed`.
15+
- Windows compatibility pass:
16+
- `config.ExpandPath` handles both `~/...` and `~\\...`.
17+
- integration live tests support Windows via `scripts/live-test.ps1` wrapper.
18+
- README now documents Windows-native build/auth/live-test flows.
19+
- full `go test ./...` and `govulncheck` validation completed on Windows.
1520

1621
Backlog / next wins
1722

0 commit comments

Comments
 (0)