@@ -14,7 +14,7 @@ CLI ([`thv`](../reference/cli/thv.md)).
1414
1515Before installing ToolHive, make sure your system meets these requirements:
1616
17- - ** Operating systems** : macOS, Linux, or WSL ( Windows Subsystem for Linux)
17+ - ** Operating systems** : macOS, Linux, or Windows
1818- ** Container runtime** : Docker or Podman
1919
2020ToolHive requires minimal CPU, memory, and disk space. The exact requirements
@@ -36,28 +36,28 @@ brew install thv
3636</TabItem >
3737<TabItem value = ' binary' label = ' Pre-compiled binaries' >
38381 . Visit the [ ToolHive releases page] ( https://github.com/stacklok/toolhive/releases )
39+
39402 . Download the appropriate binary for your platform:
41+
4042 - ` toolhive_<version>_darwin_amd64.tar.gz ` for macOS (Intel)
4143 - ` toolhive_<version>_darwin_arm64.tar.gz ` for macOS (Apple Silicon)
4244 - ` toolhive_<version>_linux_amd64.tar.gz ` for Linux (x86_64)
4345 - ` toolhive_<version>_linux_arm64.tar.gz ` for Linux (ARM64)
44- 3 . Extract the archive:
45-
46- ``` bash
47- tar -xzf toolhive_< version> _< platform> .tar.gz
48- ```
46+ - ` toolhive_<version>_windows_amd64.zip ` for Windows (x86_64)
47+ - ` toolhive_<version>_windows_arm64.zip ` for Linux (ARM64)
4948
50- 4 . Move the binary to a directory in your PATH, for example :
49+ 3 . Extract the archive and copy the binary to a directory in your PATH:
5150
52- ``` bash
53- sudo mv thv /usr/local/bin/
54- ```
51+ macOS/Linux:
5552
56- 5 . Make it executable (if needed):
53+ ``` bash
54+ tar -xzf toolhive_< version> _< platform> .tar.gz
55+ sudo mv thv /usr/local/bin/
56+ sudo chmod +x /usr/local/bin/thv
57+ ```
5758
58- ``` bash
59- sudo chmod +x /usr/local/bin/thv
60- ```
59+ On Windows, extract the ZIP file to a folder and add that folder to your PATH
60+ environment variable.
6161
6262</TabItem >
6363<TabItem value = ' source' label = ' Build from source' >
@@ -66,8 +66,18 @@ sudo chmod +x /usr/local/bin/thv
6666
6767- Go 1.24 or newer
6868- Git
69+ - Your ` $GOPATH/bin ` directory should be in your PATH
6970
70- #### Using Go tools
71+ #### Using Task (recommended)
72+
73+ :::note
74+
75+ The Task scripts currently only support macOS and Linux. Windows users should
76+ use the pre-compiled binaries or build from source using Go tools.
77+
78+ :::
79+
80+ If you have [ Task] ( https://taskfile.dev/installation/ ) installed:
7181
72821 . Clone the repository:
7383
@@ -76,16 +86,13 @@ sudo chmod +x /usr/local/bin/thv
7686 cd toolhive
7787 ```
7888
79- 2 . Build and install:
89+ 2 . Build and install the binary in your ` $GOPATH/bin ` :
8090
8191 ``` bash
82- go build ./cmd/thv
83- go install ./cmd/thv
92+ task install
8493 ```
8594
86- #### Using Task
87-
88- If you have [ Task] ( https://taskfile.dev/installation/ ) installed:
95+ #### Using Go tools
8996
90971 . Clone the repository:
9198
@@ -94,11 +101,10 @@ If you have [Task](https://taskfile.dev/installation/) installed:
94101 cd toolhive
95102 ```
96103
97- 2 . Build and install:
104+ 2 . Build and install the binary in your ` $GOPATH/bin ` :
98105
99106 ``` bash
100- task build
101- task install
107+ go install ./cmd/thv
102108 ```
103109
104110</TabItem >
@@ -151,22 +157,20 @@ downloading the latest release and overwriting the previous binary.
151157If you built ToolHive from source, upgrade it by pulling the latest changes and
152158rebuilding:
153159
154- #### Using Go tools
160+ #### Using Task:
155161
156162``` bash
157163git pull
158164
159- go build ./cmd/thv
160- go install ./cmd/thv
165+ task install
161166```
162167
163- #### Using Task:
168+ #### Using Go tools
164169
165170``` bash
166171git pull
167172
168- task build
169- task install
173+ go install ./cmd/thv
170174```
171175
172176</TabItem >
0 commit comments