Document CLI and UI coexistence for version alignment#519
Open
Document CLI and UI coexistence for version alignment#519
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Document how ToolHive UI manages CLI installation, the Settings > CLI page, and troubleshooting for CLI access issues.
Revise tips in UI and CLI index pages to reflect that ToolHive UI manages CLI installation automatically.
Document conflict detection when standalone CLI runs alongside ToolHive UI, including error message and resolution options.
Link to new CLI access guide in the Next steps section.
Explain that ToolHive UI and standalone CLI cannot be used together.
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request documents the CLI and UI version alignment feature, which ensures that ToolHive UI automatically manages a compatible CLI installation. The documentation explains how the UI manages the CLI, what happens when conflicts occur with standalone CLI installations, and how users can access CLI functionality from the UI.
Changes:
- New guide explaining CLI access from ToolHive UI, including management, settings, and troubleshooting
- Updated CLI install guide with a new section on CLI/UI coexistence and conflict resolution
- Added tips and information boxes across UI and CLI guides to inform users about the relationship between the two
- New FAQ entry clarifying that ToolHive UI and standalone CLI cannot coexist
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| sidebars.ts | Adds navigation entry for the new CLI access guide in the UI guides section |
| docs/toolhive/guides-ui/cli-access.mdx | New comprehensive guide covering CLI management by ToolHive UI, Settings page details, usage instructions, and troubleshooting |
| docs/toolhive/guides-ui/install.mdx | Adds tip directing advanced users to the CLI access guide after installation |
| docs/toolhive/guides-ui/index.mdx | Updates tip to clarify that UI includes and manages CLI automatically |
| docs/toolhive/guides-cli/install.mdx | Adds new section explaining conflict detection, resolution steps, and debugging override |
| docs/toolhive/guides-cli/index.mdx | Updates tip to inform users that UI automatically manages CLI if installed |
| docs/toolhive/faq.mdx | Adds FAQ entry explaining CLI/UI coexistence behavior and linking to relevant guides |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.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.
Description
Document the CLI and UI version alignment feature, explaining how ToolHive UI
manages CLI installation automatically and what happens when a standalone CLI
conflicts with a UI-managed installation.
Changes include:
Settings > CLI page, and troubleshooting
Type of change
Related issues/PRs
Content and formatting
Navigation
sidebars.ts) updated for added, deleted, reordered, or renamed files