Skip to content

Commit 50238f1

Browse files
authored
Update installation instructions (#10)
- Add WInGet method to the quickstart tutorial - Note the need to start a new terminal in Windows - Note that Homebrew works on Linux too - Simplify *nix binary install commands
1 parent e8f732f commit 50238f1

File tree

3 files changed

+19
-12
lines changed

3 files changed

+19
-12
lines changed

docs/toolhive/guides-cli/install.mdx

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ depend on how many MCP servers you run and what resources they use.
2525
You can install ToolHive using several methods:
2626

2727
<Tabs groupId='installer' queryString='installer'>
28-
<TabItem value='macos' label='Homebrew (macOS)' default>
29-
If you use Homebrew on macOS, this is the easiest installation method:
28+
<TabItem value='homebrew' label='Homebrew (macOS/Linux)' default>
29+
Homebrew is the easiest installation method on macOS or Linux:
3030

3131
```bash
3232
brew tap stacklok/tap
@@ -41,6 +41,9 @@ WinGet is available by default on Windows, making this the easiest installation
4141
winget install stacklok.thv
4242
```
4343

44+
Open a new terminal window after installation to ensure the `thv` command is
45+
available.
46+
4447
</TabItem>
4548
<TabItem value='binary' label='Pre-compiled binaries'>
4649
1. Visit the [ToolHive releases page](https://github.com/stacklok/toolhive/releases)
@@ -60,16 +63,14 @@ winget install stacklok.thv
6063

6164
```bash
6265
tar -xzf toolhive_<version>_<platform>.tar.gz
63-
sudo mv thv /usr/local/bin/
64-
sudo chmod +x /usr/local/bin/thv
66+
sudo install -m 0755 thv /usr/local/bin/
6567
```
6668

6769
On Windows, extract the ZIP file to a folder and add that folder to your PATH
6870
environment variable.
6971

7072
</TabItem>
7173
<TabItem value='source' label='Build from source'>
72-
7374
#### Prerequisites for building from source
7475

7576
- Go 1.24 or newer
@@ -145,8 +146,7 @@ exists.
145146
To upgrade ToolHive:
146147

147148
<Tabs groupId='installer' queryString='installer'>
148-
<TabItem value='macos' label='Homebrew (macOS)' default>
149-
149+
<TabItem value='homebrew' label='Homebrew (macOS)' default>
150150
If you installed ToolHive via Homebrew, upgrade it with:
151151

152152
```bash
@@ -155,7 +155,6 @@ brew upgrade thv
155155

156156
</TabItem>
157157
<TabItem value='winget' label='WinGet (Windows)'>
158-
159158
If you installed ToolHive via WinGet, upgrade it with:
160159

161160
```bash
@@ -164,13 +163,11 @@ winget upgrade stacklok.thv
164163

165164
</TabItem>
166165
<TabItem value='binary' label='Pre-compiled binaries'>
167-
168166
Follow the same steps as the [initial installation](#install-toolhive),
169167
downloading the latest release and overwriting the previous binary.
170168

171169
</TabItem>
172170
<TabItem value='source' label='Build from source'>
173-
174171
If you built ToolHive from source, upgrade it by pulling the latest changes and
175172
rebuilding:
176173

docs/toolhive/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ manage MCP servers centrally.
9191

9292
ToolHive offers the following features to simplify MCP deployment:
9393

94-
- **Simplified deployment**: Deploy MCP servers instantly with a single command
94+
- **Streamlined deployment**: Deploy MCP servers instantly with a single command
9595
using Docker containers or directly from package managers via protocol schemes
9696
(`uvx://`, `npx://`, `go://`). Access a curated registry of verified MCP
9797
servers that you can discover and run effortlessly.

docs/toolhive/tutorials/quickstart.mdx

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,23 @@ For detailed installation instructions, see the
4040
[installing ToolHive](../guides-cli/install.mdx) guide. Here's a quick summary:
4141

4242
<Tabs groupId='installer' queryString='installer'>
43-
<TabItem value='homebrew' label='Homebrew (macOS)' default>
43+
<TabItem value='homebrew' label='Homebrew (macOS/Linux)' default>
4444

4545
```bash
4646
brew tap stacklok/tap
4747
brew install thv
4848
```
4949

50+
</TabItem>
51+
<TabItem value='winget' label='WinGet (Windows)' default>
52+
53+
```bash
54+
winget install stacklok.thv
55+
```
56+
57+
Open a new terminal window after installation to ensure the `thv` command is
58+
available.
59+
5060
</TabItem>
5161
<TabItem value='binary' label='Pre-compiled binaries'>
5262

0 commit comments

Comments
 (0)