Skip to content

Commit 7c450b8

Browse files
committed
Document --verify-checksum
1 parent 9e52039 commit 7c450b8

2 files changed

Lines changed: 10 additions & 0 deletions

File tree

Cargo.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ include = [
2020
"README.md",
2121
"LICENSE-MIT",
2222
"LICENSE-APACHE",
23+
"CHANGELOG.md",
2324
]
2425

2526
[[bin]]

docs/installation_guide.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -197,6 +197,13 @@ uvx celq -n '"Hello World"'
197197

198198
`celq` publishes a `SHA256SUMS` file for each of its release in the [GitHub Releases page](https://github.com/IvanIsCoding/celq/releases). The checksum can be used to verify integrity of the downloaded files.
199199

200+
The `celq` installer supports the `--verify-checksum` flag to ensure the integrity of the pre-built binaries:
201+
202+
```bash
203+
curl --proto '=https' --tlsv1.2 -sSf https://get-celq.github.io/install.sh | \
204+
bash -s -- --verify-checksum
205+
```
206+
200207
`celq` also generates [artifact attestations](https://github.com/IvanIsCoding/celq/attestations) for each file in the Releases page, including the installer. To verify the authenticity of a file, use the [GitHub CLI](https://cli.github.com/) with the following command:
201208

202209
```bash
@@ -218,6 +225,8 @@ bash install.sh --verify-attestation
218225

219226
This way, you can guarantee that both the installer and the downloaded binaries are authentic.
220227

228+
Running the installer with the `--verify-checksum` requires either `sha256sum` or `shasum` to be available. If none of these tools is available, the installer will fail.
229+
221230
Running the installer with the `--verify-attestation` requires the GitHub CLI (`gh`). If `gh` is not found, the script will fail. If the user is not authenticated (`gh auth login`), the option will also fail. For scripts and non-interactive environments like CI, `gh auth login --with-token $GITHUB` is an option for authenticaitng when using this installer feature.
222231

223232
## Shell Script Installer Quirks

0 commit comments

Comments
 (0)