Document thv registry login and logout#934
Open
danbarr wants to merge 3 commits into
Open
Conversation
The registry login/logout commands existed in the CLI reference but weren't covered in the registry guide, leaving readers without instructions for authenticating to a protected remote registry. Add an "Authenticate to a protected registry" subsection under "Set a remote registry" that explains the interactive OAuth/OIDC login flow, the required and optional flags, the credential-clearing behavior when changing registries, and how to log out. Cross-link to the Registry Server authentication guide. Addresses docs-website issue #654 (high-priority gap #4). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull request overview
Adds missing CLI guide coverage for authenticating to protected remote registries, aligning the guides-cli/registry.mdx how-to content with the existing auto-generated CLI reference for thv registry login / thv registry logout.
Changes:
- Documented interactive OAuth/OIDC login flow for protected remote registries (
thv registry login), including required configuration and supported flags. - Documented clearing cached registry credentials via
thv registry logout. - Added a cross-link to the Registry Server’s authentication configuration guide for server-side setup details.
danbarr
force-pushed
the
docs-cli-registry-login
branch
from
5c47625 to
4cd459a
Compare
The section led with a bare `thv registry login`, which fails for a first-time user with no saved configuration. Lead with the full required-flags command and present the no-flags form as the follow-up for subsequent logins, matching the actual command behavior. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
danbarr
force-pushed
the
docs-cli-registry-login
branch
from
4cd459a to
0f5a041
Compare
Add the --issuer/--client-id/--audience/--scopes OIDC flags and the --allow-private-ip flag on thv config set-registry, with a pointer to the registry login flow. Addresses medium-priority registry gaps in #654. Co-Authored-By: Claude Opus 4.8 (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
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.
Description
Documents the
thv registry loginandthv registry logoutcommands, which existed in the CLI reference but weren't covered in the registry guide. A new "Authenticate to a protected registry" subsection under "Set a remote registry" explains that ToolHive authenticates to protected remote registries with an interactive browser-based OAuth login backed by an OIDC identity provider, walks through runningthv registry login(with no flags when config is already saved, or with--registry,--issuer, and--client-idto supply and persist the required values), documents all supported flags including the optional--audienceand the defaultopenid,offline_accessscopes, notes that OAuth login applies only to remote registries and that supplying a new--registryURL clears previously saved credentials, and covers clearing cached tokens withthv registry logout. Every flag, default, and behavior was verified against the ToolHive source (cmd/thv/app/registry_login.go,registry_logout.go, andpkg/registry/auth/login.go) and the auto-generated CLI reference, and the section cross-links to the Registry Server authentication guide.Type of change
Related issues/PRs
Addresses #654 (high-priority gap # 4: registry login/logout)