Skip to content

Commit 503315b

Browse files
Justin Poehneltjpoehnelt-bot
andauthored
docs: update installation instructions to prioritize github releases (#656)
* docs: update installation instructions to prioritize github releases * ci: add explicit verification instructions to github release notes --------- Co-authored-by: jpoehnelt-bot <jpoehnelt-bot@users.noreply.github.com>
1 parent ecddf2e commit 503315b

4 files changed

Lines changed: 48 additions & 11 deletions

File tree

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@googleworkspace/cli": patch
3+
---
4+
5+
Update installation instructions to prioritize GitHub Releases over npm

.github/workflows/release.yml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,9 +144,42 @@ jobs:
144144
if [ "${{ needs.plan.outputs.prerelease }}" = "true" ]; then
145145
PRERELEASE_FLAG="--prerelease"
146146
fi
147+
148+
NOTES="## Installation
149+
150+
Download the archive for your OS and architecture from the assets below.
151+
152+
### Linux / macOS
153+
154+
Replace \`<target>\` with your platform (e.g., \`aarch64-apple-darwin\` or \`x86_64-unknown-linux-gnu\`).
155+
156+
\`\`\`bash
157+
# 1. Download the archive and its checksum
158+
curl -sLO https://github.com/googleworkspace/cli/releases/download/${{ github.ref_name }}/google-workspace-cli-<target>.tar.gz
159+
curl -sLO https://github.com/googleworkspace/cli/releases/download/${{ github.ref_name }}/google-workspace-cli-<target>.tar.gz.sha256
160+
161+
# 2. Verify the checksum
162+
shasum -a 256 -c google-workspace-cli-<target>.tar.gz.sha256
163+
164+
# 3. Extract and install
165+
tar -xzf google-workspace-cli-<target>.tar.gz
166+
chmod +x gws
167+
sudo mv gws /usr/local/bin/
168+
\`\`\`
169+
170+
### Windows
171+
172+
1. Download \`google-workspace-cli-x86_64-pc-windows-msvc.zip\` and its \`.sha256\` file
173+
2. Verify the checksum (e.g., using PowerShell \`Get-FileHash\`)
174+
3. Extract the archive and move \`gws.exe\` to a directory included in your system \`PATH\`.
175+
176+
---
177+
"
178+
147179
gh release create "${{ github.ref_name }}" \
148180
--target "${{ github.sha }}" \
149181
--title "${{ github.ref_name }}" \
182+
--notes "$NOTES" \
150183
--generate-notes \
151184
$PRERELEASE_FLAG \
152185
artifacts/*

README.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,7 @@ Drive, Gmail, Calendar, and every Workspace API. Zero boilerplate. Structured JS
1414
</p>
1515
<br>
1616

17-
```bash
18-
npm install -g @googleworkspace/cli
19-
```
17+
⬇️ **[Download the latest release for your OS](https://github.com/googleworkspace/cli/releases)**
2018

2119
`gws` doesn't ship a static list of commands. It reads Google's own [Discovery Service](https://developers.google.com/discovery) at runtime and builds its entire command surface dynamically. When Google Workspace adds an API endpoint or method, `gws` picks it up automatically.
2220

@@ -46,15 +44,14 @@ npm install -g @googleworkspace/cli
4644

4745
## Installation
4846

47+
The recommended way to install `gws` is to download the pre-built binary for your OS and architecture from the **[GitHub Releases](https://github.com/googleworkspace/cli/releases)** page. Extract the archive and place the `gws` binary in your `$PATH`.
48+
49+
For convenience, you can also use `npm` to automate downloading the appropriate binary from GitHub Releases:
50+
4951
```bash
5052
npm install -g @googleworkspace/cli
5153
```
5254

53-
> The npm package bundles pre-built native binaries for your OS and architecture.
54-
> No Rust toolchain required.
55-
56-
Pre-built binaries are also available on the [GitHub Releases](https://github.com/googleworkspace/cli/releases) page.
57-
5855
Or build from source:
5956

6057
```bash

crates/google-workspace-cli/README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,16 @@
66

77
## Install
88

9+
Download the pre-built binary for your OS and architecture from the **[GitHub Releases](https://github.com/googleworkspace/cli/releases)** page.
10+
11+
Alternatively, you can use package managers as a convenience layer:
12+
913
```bash
10-
npm install -g @googleworkspace/cli # npm
14+
npm install -g @googleworkspace/cli # npm (downloads GitHub release binary)
1115
cargo install google-workspace-cli # crates.io
1216
nix run github:googleworkspace/cli # nix
1317
```
1418

15-
Pre-built binaries are available on the [GitHub Releases](https://github.com/googleworkspace/cli/releases) page.
16-
1719
## Quick Start
1820

1921
```bash

0 commit comments

Comments
 (0)