Skip to content

docs: update installation instructions to prioritize github releases #656

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jpoehnelt merged 2 commits into from
Mar 31, 2026
+48 −11
Merged

docs: update installation instructions to prioritize github releases #656

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f9c73be
docs: update installation instructions to prioritize github releases
jpoehnelt-bot Mar 31, 2026
87d51eb
ci: add explicit verification instructions to github release notes
jpoehnelt-bot Mar 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/docs-github-releases-install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@googleworkspace/cli": patch
---

Update installation instructions to prioritize GitHub Releases over npm
13 changes: 5 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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
Expand Down
8 changes: 5 additions & 3 deletions crates/google-workspace-cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading