docs(readme): sync configuration and subcommand reference with implementation#38
docs(readme): sync configuration and subcommand reference with implementation#38
Conversation
…entation - Correct SCOPE default to email profile in env vars and .env.example - Document timeout and response-body-size environment variables and flags - Update token lifecycle to reference OIDC Discovery and parallel UserInfo - Fix device authorization endpoint reference to /oauth/device/code - Add Token Subcommands section covering get, inspect, decode, and delete - Note that --version is also exposed as a version subcommand
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
There was a problem hiding this comment.
Pull request overview
Updates documentation to match the current authgate-cli behavior and configuration surface area, including endpoint discovery, new timeout/limit knobs, and the expanded token utility subcommands.
Changes:
- Syncs README flow descriptions and diagrams with current endpoints and OIDC Discovery behavior (including parallel token verification + UserInfo fetch).
- Documents timeout/limit environment variables and corresponding CLI flags.
- Adds a dedicated “Token Subcommands” section and updates
.env.examplescope defaults.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Updates configuration defaults, documents new timeout/limit controls, and adds/expands token subcommand reference. |
| .env.example | Updates the default SCOPE example to match current CLI defaults. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Replace inaccurate POST description with HTTP GET and Authorization Bearer header for token inspect
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Note UserInfo and revocation endpoints come from OIDC Discovery and treat the hardcoded paths as defaults - Clarify that the configurable timeouts cover OAuth flow steps and that the auto-refresh demo reuses the parent context - Tighten MAX_RESPONSE_BODY_SIZE description to reflect parsed responses and call out the fixed 4 KiB revocation drain
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Note refresh token revocation only runs when a refresh token is present - Distinguish duration parsing from MAX_RESPONSE_BODY_SIZE byte parsing in the timeouts intro
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Reword the post-auth step to note verification and UserInfo fetch run after any selected token, not only after interactive auth
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Summary
Test plan
🤖 Generated with Claude Code