Skip to content

Commit 7fceddb

Browse files
appleboyclaude
andcommitted
docs(readme): update TUI mockups to match actual code output
- Update browser and device flow diagrams to reflect actual rendering - Remove non-existent outer border wrapping from TUI mockups - Add step indicators and backoff warning to device flow diagram - Correct header, spinner symbols, and help text to match code - Remove messages not printed by current implementation Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent bc24da8 commit 7fceddb

1 file changed

Lines changed: 44 additions & 41 deletions

File tree

README.md

Lines changed: 44 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -173,46 +173,51 @@ The TUI provides:
173173
### Browser Flow (Authorization Code + PKCE)
174174

175175
```
176-
╭─────────────────────────────────────────────────╮
177-
│ Authorization Code Flow with PKCE │
178-
├─────────────────────────────────────────────────┤
179-
│ │
180-
│ ● Step 1/3: Opening browser ✓ │
181-
│ ● Step 2/3: Waiting for callback ◐ │
182-
│ ○ Step 3/3: Exchanging tokens │
183-
│ │
184-
│ Time remaining: 1:23 / 2:00 │
185-
│ ▓▓▓▓▓▓▓▓▓▓▓▓░░░░░░░░░░░░░ 48% │
186-
│ │
187-
│ ◐ Please complete authorization in your browser │
188-
│ │
189-
│ Press Ctrl+C to cancel │
190-
╰─────────────────────────────────────────────────╯
176+
╭──────────────────────────────────────────────────╮
177+
│ Authorization Code Flow with PKCE │
178+
╰──────────────────────────────────────────────────╯
179+
180+
● Step 1/3: Opening browser (green, completed)
181+
● Step 2/3: Waiting for callback (purple, current)
182+
○ Step 3/3: Exchanging tokens (gray, pending)
183+
184+
Time remaining: 1:23 / 2:00
185+
████████████░░░░░░░░░░░░░ 48%
186+
187+
⠙ Please complete authorization in your browser
188+
189+
ctrl+c: cancel authentication • ?: toggle help
191190
```
192191

193192
### Device Flow (Device Authorization Grant)
194193

195194
```
196-
╭─────────────────────────────────────────────────╮
197-
│ Device Authorization Grant Flow │
198-
├─────────────────────────────────────────────────┤
199-
│ │
200-
│ ╔═══════════════════════════════════════════╗ │
201-
│ ║ Device Authorization ║ │
202-
│ ║ ║ │
203-
│ ║ Visit: https://auth.example.com/device ║ │
204-
│ ║ ?user_code=ABCD-EFGH ║ │
205-
│ ║ ║ │
206-
│ ║ Or go to: https://auth.example.com ║ │
207-
│ ║ And enter: ABCD-EFGH ║ │
208-
│ ╚═══════════════════════════════════════════╝ │
209-
│ │
210-
│ ◐ Waiting for authorization... (poll #8, 5s) │
211-
│ │
212-
│ Elapsed: 0:43 │
213-
│ │
214-
│ Press Ctrl+C to cancel │
215-
╰─────────────────────────────────────────────────╯
195+
╭──────────────────────────────────────────────────╮
196+
│ Device Authorization Grant Flow │
197+
╰──────────────────────────────────────────────────╯
198+
199+
● Step 1/2: Requesting device code (green, completed)
200+
● Step 2/2: Waiting for authorization (purple, current)
201+
202+
╔══════════════════════════════════════════════════╗
203+
║ Device Authorization ║
204+
║ ║
205+
║ Please authorize this device: ║
206+
║ ║
207+
║ Visit: https://auth.example.com/device ║
208+
║ ?user_code=ABCD-EFGH ║
209+
║ ║
210+
║ Or go to: https://auth.example.com/device ║
211+
║ And enter: ABCD-EFGH ║
212+
╚══════════════════════════════════════════════════╝
213+
214+
⠙ Waiting for authorization... (poll #8, interval: 5s)
215+
216+
⚠ Server requested slower polling: 5s → 10s
217+
218+
Elapsed: 0:43
219+
220+
ctrl+c: cancel authentication • ?: toggle help
216221
```
217222

218223
### UI Mode Selection
@@ -292,7 +297,7 @@ Configuration is resolved in priority order: **CLI flag → environment variable
292297
Used when a local browser and a free callback port are available. Suitable for developer workstations.
293298

294299
```
295-
=== AuthGate CLI ===
300+
=== AuthGate Hybrid CLI (Browser + Device Code Flow) ===
296301
Client mode : public (PKCE)
297302
Server URL : http://localhost:8080
298303
Client ID : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
@@ -304,9 +309,7 @@ Step 1: Opening browser for authorization...
304309
305310
Browser opened. Please complete authorization in your browser.
306311
Step 2: Waiting for callback on http://localhost:8888/callback ...
307-
Authorization code received!
308312
Step 3: Exchanging authorization code for tokens...
309-
Tokens saved to .authgate-tokens.json
310313
```
311314

312315
**Security properties:**
@@ -321,9 +324,10 @@ Tokens saved to .authgate-tokens.json
321324
Used when no browser is available: SSH sessions without display forwarding, Linux servers, CI environments.
322325

323326
```
324-
=== AuthGate CLI ===
327+
=== AuthGate Hybrid CLI (Browser + Device Code Flow) ===
325328
Auth method : Device Code Flow (SSH session without display forwarding)
326329
Step 1: Requesting device code...
330+
Step 2: Waiting for authorization...
327331
328332
----------------------------------------
329333
Please open this link to authorize:
@@ -333,9 +337,8 @@ Or visit : http://localhost:8080/device
333337
And enter: ABC-12345
334338
----------------------------------------
335339
336-
Step 2: Waiting for authorization...............
340+
.....
337341
Authorization successful!
338-
Tokens saved to .authgate-tokens.json
339342
```
340343

341344
**Polling behavior:**

0 commit comments

Comments
 (0)