-
Notifications
You must be signed in to change notification settings - Fork 2
Document CLI and UI coexistence for version alignment #519
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
ce79726
Add CLI access guide for ToolHive UI
samuv eb05751
Update index pages with CLI/UI coexistence info
samuv b2a0ce8
Add CLI and UI coexistence section to CLI install guide
samuv d8eaf8f
Add CLI access tip to UI install guide
samuv af8a95e
Add FAQ entry for CLI/UI coexistence
samuv e25b11b
Update docs/toolhive/guides-ui/cli-access.mdx
samuv 3bdd81f
Update docs/toolhive/guides-ui/cli-access.mdx
samuv 26fcd7b
fix: adress feedback
samuv File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| --- | ||
| title: Access the CLI from ToolHive UI | ||
| description: | ||
| How to use the ToolHive CLI when using the ToolHive UI application for | ||
| advanced features and terminal-based workflows. | ||
| --- | ||
|
|
||
| ToolHive UI includes the CLI for advanced users who want terminal access or | ||
| features not yet available in the graphical interface. ToolHive UI automatically | ||
| installs and manages the CLI, so you don't need to install it separately. | ||
|
|
||
| ## Why use the CLI with ToolHive UI? | ||
|
|
||
| While the ToolHive UI covers most common tasks, you might want to use the CLI | ||
| for: | ||
|
|
||
| - **Advanced features**: Some features are available in the CLI before they're | ||
| added to the graphical interface | ||
| - **Scripting and automation**: Integrate MCP server management into local | ||
| scripts or automated workflows | ||
| - **Personal preference**: If you prefer working in a terminal for certain | ||
| tasks, the CLI is available without a separate installation | ||
|
|
||
| ## Use CLI commands | ||
|
|
||
| After ToolHive UI installation, you can use the CLI from your terminal: | ||
|
|
||
| 1. Open a new terminal window to pick up the PATH changes. | ||
|
|
||
| 1. Verify the CLI is available: | ||
|
|
||
| ```bash | ||
| thv version | ||
| ``` | ||
|
|
||
| 1. Run any CLI command: | ||
|
|
||
| ```bash | ||
| thv list # List running MCP servers | ||
| thv registry list # Browse available servers | ||
| thv --help # View all commands | ||
| ``` | ||
|
|
||
| For detailed command reference, see the [CLI guides](../guides-cli/index.mdx) | ||
| and [command reference](../reference/cli/thv.md). | ||
|
|
||
| ## How ToolHive UI manages the CLI | ||
|
|
||
| When you install ToolHive UI, it automatically: | ||
|
|
||
| 1. **Creates a symlink** to its bundled CLI binary: | ||
| - macOS/Linux: `~/.toolhive/bin/thv` | ||
| - Windows: `%LOCALAPPDATA%\ToolHive\bin\thv.exe` | ||
|
|
||
| 1. **Configures your PATH** by adding entries to your shell configuration files | ||
| (`.bashrc`, `.zshrc`, `config.fish`, or the Windows User PATH) | ||
|
|
||
| This ensures the CLI version always matches the ToolHive UI version, preventing | ||
| compatibility issues with the API. | ||
|
|
||
| :::note | ||
|
|
||
| If you have a standalone CLI installed (via Homebrew, WinGet, or manually), it | ||
| will show a conflict error. See | ||
| [CLI conflict resolution](../guides-cli/install.mdx#cli-conflict-resolution) for | ||
| details. | ||
|
|
||
| ::: | ||
|
|
||
| ## The Settings > CLI page | ||
|
|
||
| ToolHive UI includes a dedicated settings page to manage the CLI installation. | ||
| Access it from **Settings** (gear icon) > **CLI**. | ||
|
|
||
| The page displays: | ||
|
|
||
| - CLI installation status and version | ||
| - Symlink location and target path | ||
| - Shell configuration status | ||
|
|
||
| Use the **Reinstall** button if the CLI becomes unavailable or the symlink | ||
| breaks (for example, after moving the ToolHive UI application). | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| <details> | ||
| <summary>CLI not found in terminal</summary> | ||
|
|
||
| If `thv` is not recognized after installing ToolHive UI: | ||
|
|
||
| 1. **Open a new terminal window**: The PATH changes only take effect in new | ||
| terminal sessions. | ||
|
|
||
| 1. **Check the Settings > CLI page**: Verify that the PATH Configuration shows | ||
| "Valid" status. | ||
|
|
||
| 1. **Manually source your shell configuration**: | ||
|
|
||
| ```bash | ||
| # Bash | ||
| source ~/.bashrc | ||
|
|
||
| # Zsh | ||
| source ~/.zshrc | ||
|
|
||
| # Fish | ||
| source ~/.config/fish/config.fish | ||
| ``` | ||
|
|
||
| 1. **Reinstall the CLI**: Go to Settings > CLI and click **Reinstall**. | ||
|
|
||
| </details> | ||
|
|
||
| <details> | ||
| <summary>Broken symlink after moving ToolHive UI</summary> | ||
|
|
||
| If you move the ToolHive UI application to a different location, the CLI symlink | ||
| may break. To fix this: | ||
|
|
||
| 1. Open ToolHive UI from its new location. | ||
| 1. Go to Settings > CLI. | ||
| 1. Click **Reinstall** to create a new symlink pointing to the correct location. | ||
|
|
||
| </details> | ||
|
|
||
| <details> | ||
| <summary>CLI conflict error when running thv</summary> | ||
|
|
||
| If you see "CLI conflict detected", you have both ToolHive UI and a standalone | ||
| CLI installed. See | ||
| [CLI conflict resolution](../guides-cli/install.mdx#cli-conflict-resolution) for | ||
| the error message and resolution steps. | ||
|
|
||
samuv marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| </details> | ||
|
|
||
| ## Related information | ||
|
|
||
| - [CLI guides](../guides-cli/index.mdx) | ||
| - [CLI command reference](../reference/cli/thv.md) | ||
| - [CLI conflict resolution](../guides-cli/install.mdx#cli-conflict-resolution) | ||
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
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
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
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.
Uh oh!
There was an error while loading. Please reload this page.