Skip to content

Commit af48e6d

Browse files
committed
Improve documentation on download
1 parent 6f1a4e4 commit af48e6d

File tree

1 file changed

+29
-8
lines changed

1 file changed

+29
-8
lines changed

src/reference/download_links.md

+29-8
Original file line numberDiff line numberDiff line change
@@ -14,36 +14,57 @@ This API will return a JSON similar to:
1414
```json
1515
{
1616
"id": "01J4KSCQQFY1E9SWEEKJ1WMJWD",
17-
"version": "0.40.0",
17+
"version": "0.47.3",
1818
"links": [
1919
{
2020
"display": "Linux x86_64",
2121
"platform": "linux-x86_64",
2222
"kind": "cli",
23-
"link": "https://caido.download/releases/v0.40.0/caido-cli-v0.40.0-linux-x86_64.tar.gz"
23+
"link": "https://caido.download/releases/v0.47.3/caido-cli-v0.47.3-linux-x86_64.tar.gz",
24+
"os": "linux",
25+
"arch": "x86_64",
26+
"format": "tar.gz",
27+
"hash": "gu9MUK4jnHZSQUENeP+29JXz79kPaJO8QHZlagSxLdNJ1qaC3IRwTbcLeU+g2M10WGsdWlrwua6meL1gYQ3tYw=="
2428
},
2529
{
2630
"display": "macOS Desktop x86_64",
2731
"platform": "mac-x86_64",
2832
"kind": "desktop",
29-
"link": "https://caido.download/releases/v0.40.0/caido-desktop-v0.40.0-mac-x86_64.dmg"
33+
"link": "https://caido.download/releases/v0.47.3/caido-desktop-v0.47.3-mac-x86_64.dmg",
34+
"os": "macos",
35+
"arch": "x86_64",
36+
"format": "dmg",
37+
"hash": "1Be/o7cHKaEGELuq24d0yonI9TRCwlWLfzviafYVXKT6RUZ4YBdfI2RNAqZJ6jz+ViLj02XgVciTATJHn2c7xA=="
3038
},
3139
{
3240
"display": "Windows Desktop x86_64",
3341
"platform": "win-x86_64",
3442
"kind": "desktop",
35-
"link": "https://caido.download/releases/v0.40.0/caido-desktop-v0.40.0-win-x86_64.exe"
43+
"link": "https://caido.download/releases/v0.47.3/caido-desktop-v0.47.3-win-x86_64.exe",
44+
"os": "windows",
45+
"arch": "x86_64",
46+
"format": "exe",
47+
"hash": "p8Rr3wOe3Fbm7eETOogP0ulpifeDFAm+gVxDVItuK4B5wbAOgqqjwZEKoJArcDnAclvmVRtOAQlSXM7dg+amZA=="
3648
}
3749
// ... Other links
3850
],
39-
"released_at": "2024-08-06T12:07:31.818473Z"
51+
"released_at": "2025-03-27T19:52:00.851138Z"
4052
}
4153
```
4254

4355
- `display`: What you should display to an end-user.
44-
- `platform`: We support three OS (`linux`, `mac`, `win`) and two architectures (`x86_64` and `aarch64`). The format is `[OS]-[ARCH]`.
45-
- `kind`: It will be either `desktop` or `cli`. See our [documention on the difference](/concepts/essentials/cli_vs_desktop.md).
46-
- `link`: Download link.
56+
- `platform`: (Deprecated) We support three OS (`linux`, `mac`, `win`) and two architectures (`x86_64` and `aarch64`). The format is `[OS]-[ARCH]`.
57+
- `kind`: Either `desktop` or `cli`. See our [documention on the difference](/concepts/essentials/cli_vs_desktop.md).
58+
- `link`: The download link
59+
- `os`: The operating system of the binary (`linux`, `macos`, `windows`)
60+
- `arch`: The architecture of the binary (`x86_64`, `aarch64`)
61+
- `format`: The archive/binary format (`zip`, `tar.gz`, `deb`, `AppImage`, `dmg`, `exe`)
62+
- `hash`: The SHA512 hash of the file in base64 (might be null for older releases)
63+
64+
::: info
65+
If you prefer a file-based hash, we also build `[link].sha256` and `[link].sha512` files for each binary.
66+
Those are hex encoded and will be the same output as `shasum -a 256` and `shasum -a 512`.
67+
:::
4768

4869
::: warning
4970
The download links **will redirect** to a signed URL, make sure your download client follows redirects.

0 commit comments

Comments
 (0)