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>
This commit is contained in:
Justin Poehnelt
2026-03-31 12:11:46 -06:00
committed by GitHub
parent ecddf2ec86
commit 503315bc42
4 changed files with 48 additions and 11 deletions
@@ -0,0 +1,5 @@
---
"@googleworkspace/cli": patch
---
Update installation instructions to prioritize GitHub Releases over npm
+33
View File
@@ -144,9 +144,42 @@ jobs:
if [ "${{ needs.plan.outputs.prerelease }}" = "true" ]; then
PRERELEASE_FLAG="--prerelease"
fi
NOTES="## Installation
Download the archive for your OS and architecture from the assets below.
### Linux / macOS
Replace \`<target>\` with your platform (e.g., \`aarch64-apple-darwin\` or \`x86_64-unknown-linux-gnu\`).
\`\`\`bash
# 1. Download the archive and its checksum
curl -sLO https://github.com/googleworkspace/cli/releases/download/${{ github.ref_name }}/google-workspace-cli-<target>.tar.gz
curl -sLO https://github.com/googleworkspace/cli/releases/download/${{ github.ref_name }}/google-workspace-cli-<target>.tar.gz.sha256
# 2. Verify the checksum
shasum -a 256 -c google-workspace-cli-<target>.tar.gz.sha256
# 3. Extract and install
tar -xzf google-workspace-cli-<target>.tar.gz
chmod +x gws
sudo mv gws /usr/local/bin/
\`\`\`
### Windows
1. Download \`google-workspace-cli-x86_64-pc-windows-msvc.zip\` and its \`.sha256\` file
2. Verify the checksum (e.g., using PowerShell \`Get-FileHash\`)
3. Extract the archive and move \`gws.exe\` to a directory included in your system \`PATH\`.
---
"
gh release create "${{ github.ref_name }}" \
--target "${{ github.sha }}" \
--title "${{ github.ref_name }}" \
--notes "$NOTES" \
--generate-notes \
$PRERELEASE_FLAG \
artifacts/*
+5 -8
View File
@@ -14,9 +14,7 @@ Drive, Gmail, Calendar, and every Workspace API. Zero boilerplate. Structured JS
</p>
<br>
```bash
npm install -g @googleworkspace/cli
```
⬇️ **[Download the latest release for your OS](https://github.com/googleworkspace/cli/releases)**
`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.
@@ -46,15 +44,14 @@ npm install -g @googleworkspace/cli
## Installation
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`.
For convenience, you can also use `npm` to automate downloading the appropriate binary from GitHub Releases:
```bash
npm install -g @googleworkspace/cli
```
> The npm package bundles pre-built native binaries for your OS and architecture.
> No Rust toolchain required.
Pre-built binaries are also available on the [GitHub Releases](https://github.com/googleworkspace/cli/releases) page.
Or build from source:
```bash
+5 -3
View File
@@ -6,14 +6,16 @@
## Install
Download the pre-built binary for your OS and architecture from the **[GitHub Releases](https://github.com/googleworkspace/cli/releases)** page.
Alternatively, you can use package managers as a convenience layer:
```bash
npm install -g @googleworkspace/cli # npm
npm install -g @googleworkspace/cli # npm (downloads GitHub release binary)
cargo install google-workspace-cli # crates.io
nix run github:googleworkspace/cli # nix
```
Pre-built binaries are available on the [GitHub Releases](https://github.com/googleworkspace/cli/releases) page.
## Quick Start
```bash