From 19a7a3e95a07e6b16c3cd19fbf51ad2e3db0cc43 Mon Sep 17 00:00:00 2001 From: Claude Date: Fri, 10 Apr 2026 20:38:27 +0530 Subject: [PATCH] Add changelog and update install docs for Homebrew-native CLI binaries The Appwrite CLI now ships native compiled binaries via Homebrew for macOS and Linux. Update the install docs to make Homebrew the recommended install path, add Linux Homebrew support, and add a changelog entry announcing the change. Co-Authored-By: Claude Opus 4.6 (1M context) --- .../changelog/(entries)/2026-04-10.markdoc | 27 ++++++++ .../command-line/installation/+page.markdoc | 66 +++++++++++-------- 2 files changed, 64 insertions(+), 29 deletions(-) create mode 100644 src/routes/changelog/(entries)/2026-04-10.markdoc diff --git a/src/routes/changelog/(entries)/2026-04-10.markdoc b/src/routes/changelog/(entries)/2026-04-10.markdoc new file mode 100644 index 0000000000..11cc30f01d --- /dev/null +++ b/src/routes/changelog/(entries)/2026-04-10.markdoc @@ -0,0 +1,27 @@ +--- +layout: changelog +title: "Appwrite CLI now ships native Homebrew binaries" +date: 2026-04-10 +--- + +The Appwrite CLI installed via [Homebrew](https://brew.sh/) now delivers **native compiled binaries** instead of a Node.js-based package. This means faster startup, no runtime dependencies, and a smaller install footprint on macOS and Linux. + +Supported platforms and architectures: + +- macOS Apple Silicon (arm64) +- macOS Intel (x64) +- Linux arm64 +- Linux x64 + +Install or upgrade with Homebrew: + +```sh +brew install appwrite # new install +brew upgrade appwrite # existing install +``` + +The CLI is still available via npm (`npm install -g appwrite-cli`) and platform-specific install scripts for environments where Homebrew is not an option. + +{% arrow_link href="/docs/tooling/command-line/installation" %} +Read the updated installation docs +{% /arrow_link %} diff --git a/src/routes/docs/tooling/command-line/installation/+page.markdoc b/src/routes/docs/tooling/command-line/installation/+page.markdoc index a63d163f47..f62534b439 100644 --- a/src/routes/docs/tooling/command-line/installation/+page.markdoc +++ b/src/routes/docs/tooling/command-line/installation/+page.markdoc @@ -8,33 +8,47 @@ The [Appwrite Command Line Interface (CLI)](https://github.com/appwrite/sdk-for- # Getting started {% #getting-started %} -The CLI is packaged both as an [npm module](https://www.npmjs.com/package/appwrite-cli) as well as a [standalone binary](https://github.com/appwrite/sdk-for-cli/releases/latest) for your operating system, making it completely dependency free, platform independent, and language agnostic. +The CLI is packaged as a [native binary](https://github.com/appwrite/sdk-for-cli/releases/latest) for macOS and Linux (via Homebrew), as an [npm module](https://www.npmjs.com/package/appwrite-cli), and as a standalone install script for all platforms. If you plan to use the CLI to initialize new Appwrite Functions, ensure that [Git is installed](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) on your machine. -## Install with npm {% #install-with-npm %} +## Install with Homebrew (recommended) {% #install-with-homebrew %} -If you have npm set up, run the command below to install the CLI. +On macOS and Linux, [Homebrew](https://brew.sh/) is the recommended way to install the Appwrite CLI. Homebrew delivers a **native compiled binary** for your platform and architecture, so there are no runtime dependencies and startup is instant. +{% tabs %} +{% tabsitem #macos title="macOS" %} ```sh -npm install -g appwrite-cli +brew install appwrite ``` +{% /tabsitem %} -## Install with script {% #install-with-script %} +{% tabsitem #linux title="Linux" %} +Install [Homebrew for Linux](https://docs.brew.sh/Homebrew-on-Linux), then run: -For a completely dependency-free installation, the CLI also ships with a convenient installation script for your operating system +```sh +brew install appwrite +``` +{% /tabsitem %} -{% tabs %} -{% tabsitem #macos title="macOS" %} +{% /tabs %} + +Supported architectures: Apple Silicon (arm64), Intel (x64), Linux arm64, and Linux x64. -Using [Homebrew](https://brew.sh/) +## Install with npm {% #install-with-npm %} + +If you have npm set up, you can install the CLI as a Node.js package. This works on any platform where Node.js runs. ```sh -brew install appwrite +npm install -g appwrite-cli ``` -or terminal +## Install with script {% #install-with-script %} +The CLI also ships with installation scripts for platforms where Homebrew is not available. + +{% tabs %} +{% tabsitem #macos title="macOS" %} ```sh curl -sL https://appwrite.io/cli/install.sh | bash ``` @@ -66,22 +80,19 @@ curl -sL https://appwrite.io/cli/install.sh | bash # Update your CLI {% #update-your-cli %} {% tabs %} -{% tabsitem #npm title="npm" %} +{% tabsitem #homebrew title="Homebrew" %} ```sh -npm install -g appwrite-cli +brew upgrade appwrite ``` {% /tabsitem %} -{% tabsitem #macos title="macOS" %} - -Using [Homebrew](https://brew.sh/) - +{% tabsitem #npm title="npm" %} ```sh -brew install appwrite +npm install -g appwrite-cli ``` +{% /tabsitem %} -or terminal - +{% tabsitem #macos title="macOS (script)" %} ```sh curl -sL https://appwrite.io/cli/install.sh | bash ``` @@ -93,7 +104,7 @@ iwr -useb https://appwrite.io/cli/install.ps1 | iex ``` {% /tabsitem %} -{% tabsitem #linux title="Linux" %} +{% tabsitem #linux title="Linux (script)" %} ```sh curl -sL https://appwrite.io/cli/install.sh | bash ``` @@ -203,19 +214,16 @@ If you installed Appwrite CLI using NPM, you can use the following command to un npm uninstall -g appwrite-cli ``` -If you installed the Appwrite CLI with brew or the installation script for your operating system, use the following command to uninstall it. +If you installed the Appwrite CLI with Homebrew or the installation script for your operating system, use the following command to uninstall it. {% tabs %} -{% tabsitem #macos title="macOS" %} - -Using [Homebrew](https://brew.sh/) - +{% tabsitem #homebrew title="Homebrew (macOS / Linux)" %} ```sh brew uninstall appwrite ``` +{% /tabsitem %} -or terminal - +{% tabsitem #macos title="macOS (script)" %} ```sh rm -f /usr/local/bin/appwrite | bash ``` @@ -236,7 +244,7 @@ scoop uninstall appwrite ``` {% /tabsitem %} -{% tabsitem #linux title="Linux" %} +{% tabsitem #linux title="Linux (script)" %} ```sh rm -f /usr/local/bin/appwrite | bash ```