Skip to content

Commit 6f1f4e3

Browse files
committed
Update README installation instructions
Fix download URLs to match actual release archive names and add the update command documentation.
1 parent bc6c8fc commit 6f1f4e3

File tree

1 file changed

+35
-11
lines changed

1 file changed

+35
-11
lines changed

README.md

Lines changed: 35 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -19,33 +19,57 @@ This data can be analyzed locally or shared with Cockroach Labs support for trou
1919

2020
## Installation
2121

22-
### Download Pre-Built Binary (Recommended)
22+
### Download Pre-Built Binary
2323

24-
Download the latest release for your platform from the [**Releases Page**](https://github.com/cockroachlabs/workload-exporter/releases).
24+
Download the latest release for your platform from the [**Releases Page**](https://github.com/cockroachlabs/workload-exporter/releases), or use the commands below (replace `VERSION` with the desired release tag, e.g. `v1.7.1`):
2525

26-
#### macOS
26+
#### macOS (Apple Silicon)
2727
```bash
28-
# Download and make executable
29-
curl -L https://github.com/cockroachlabs/workload-exporter/releases/latest/download/workload-exporter-darwin-amd64 -o workload-exporter
30-
chmod +x workload-exporter
28+
curl -L https://github.com/cockroachlabs/workload-exporter/releases/download/VERSION/workload-exporter-VERSION-darwin-arm64.tar.gz | tar xz
29+
mv workload-exporter-VERSION-darwin-arm64 workload-exporter
3130
```
3231

33-
#### Linux
32+
#### macOS (Intel)
3433
```bash
35-
# Download and make executable
36-
curl -L https://github.com/cockroachlabs/workload-exporter/releases/latest/download/workload-exporter-linux-amd64 -o workload-exporter
37-
chmod +x workload-exporter
34+
curl -L https://github.com/cockroachlabs/workload-exporter/releases/download/VERSION/workload-exporter-VERSION-darwin-amd64.tar.gz | tar xz
35+
mv workload-exporter-VERSION-darwin-amd64 workload-exporter
36+
```
37+
38+
#### Linux (amd64)
39+
```bash
40+
curl -L https://github.com/cockroachlabs/workload-exporter/releases/download/VERSION/workload-exporter-VERSION-linux-amd64.tar.gz | tar xz
41+
mv workload-exporter-VERSION-linux-amd64 workload-exporter
42+
```
43+
44+
#### Linux (arm64)
45+
```bash
46+
curl -L https://github.com/cockroachlabs/workload-exporter/releases/download/VERSION/workload-exporter-VERSION-linux-arm64.tar.gz | tar xz
47+
mv workload-exporter-VERSION-linux-arm64 workload-exporter
3848
```
3949

4050
#### Windows
41-
Download `workload-exporter-windows-amd64.exe` from the [releases page](https://github.com/cockroachlabs/workload-exporter/releases).
51+
Download `workload-exporter-VERSION-windows-amd64.zip` from the [releases page](https://github.com/cockroachlabs/workload-exporter/releases) and extract it.
4252

4353
### Verify Installation
4454

4555
```bash
4656
./workload-exporter version
4757
```
4858

59+
### Updating
60+
61+
Update to the latest release in-place:
62+
63+
```bash
64+
./workload-exporter update
65+
```
66+
67+
Check if a newer version is available without installing:
68+
69+
```bash
70+
./workload-exporter update --check
71+
```
72+
4973
## Quick Start
5074

5175
### Basic Export

0 commit comments

Comments
 (0)