docs: update README for typed Auth dispatch#34
Merged
packet-mover merged 1 commit intomainfrom Apr 19, 2026
Merged
Conversation
README still described the pre-v0.3.0 API with Config{Org, Token}. The
scanner now takes a sealed Auth interface implemented by PATAuth and
InstallationAuth. Rewrites:
- Intro + "How it works": framing now covers user accounts as well as
organizations (PATAuth falls back from /orgs to /users on 404;
InstallationAuth uses /installation/repositories which is
account-type-agnostic).
- "Scanner configuration": full rewrite describing both PATAuth and
InstallationAuth with examples, field tables, and field semantics.
- Token permissions: now broken out into classic PAT, fine-grained
PAT, and installation-token rows with the relevant
scopes/permissions for each.
- CLI: clarifies CODATUS_ORG accepts a user login too, and names
PATAuth as the wrapping type the CLI uses internally.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
README still described the pre-v0.3.0 API with
Config{Org, Token}. Rewrote the stale sections to match the currentAuthinterface.What changed
PATAuthandInstallationAuthwith Go examples and field tables.CODATUS_ORGaccepts a user login too, and namesPATAuthas the type the CLI wraps its env vars into.Still accurate (not touched)
🤖 Generated with Claude Code