From 9398ca9f6cdb96cbc7a44133d0e85acc2ed93a08 Mon Sep 17 00:00:00 2001 From: Austin DeNoble Date: Thu, 11 Jun 2026 13:05:03 -0400 Subject: [PATCH] reorder installation instructions in the README, add a callout for the uninstall.sh script --- README.md | 66 +++++++++++++++++++++++++++++++------------------------ 1 file changed, 37 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 63659a1..d7c4e61 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,45 @@ ## Installation +### Install script (macOS, Linux) + +The most convenient way to install the CLI on macOS and Linux is via the installation scripts. + +```bash +curl -fsSL https://pinecone.io/install.sh | sh +``` + +To pin a specific version: + +```bash +curl -fsSL https://pinecone.io/install.sh | PINECONE_VERSION=0.4.1 sh +``` + +To install to a custom directory: + +```bash +curl -fsSL https://pinecone.io/install.sh | PINECONE_INSTALL=$HOME/.local/bin sh +``` + +#### Uninstall + +To uninstall the CLI, use the uninstall script: + +```bash +curl -fsSL https://pinecone.io/uninstall.sh | sh +``` + +#### Upgrading + +Re-running the install script will fetch and install the latest version, overwriting the existing binary: + +```bash +curl -fsSL https://pinecone.io/install.sh | sh +``` + ### Homebrew (macOS, Linux) -The most convenient way to install the CLI on macOS and Linux is via [Homebrew](https://brew.sh). +You can also install the CLI on macOS and Linux is via [Homebrew](https://brew.sh). > **Note for Linux users:** Homebrew cask support on Linux requires Homebrew 4.5.0 or later. If you're on an older version, use the [install script](#install-script) or [download directly from the releases page](#download-artifacts-from-release-page-linux-windows-macos) instead. @@ -61,34 +97,6 @@ To remove the Pinecone tap entirely: brew untap pinecone-io/tap ``` -### Install script (macOS, Linux) - -The quickest way to install on macOS or Linux without Homebrew: - -```bash -curl -fsSL https://pinecone.io/install.sh | sh -``` - -To pin a specific version: - -```bash -curl -fsSL https://pinecone.io/install.sh | PINECONE_VERSION=0.4.1 sh -``` - -To install to a custom directory: - -```bash -curl -fsSL https://pinecone.io/install.sh | PINECONE_INSTALL=$HOME/.local/bin sh -``` - -#### Upgrading - -Re-running the install script will fetch and install the latest version, overwriting the existing binary: - -```bash -curl -fsSL https://pinecone.io/install.sh | sh -``` - ### Download artifacts from release page (Linux, Windows, macOS) For users who prefer not to use Homebrew or need specific platform binaries, we provide pre-built binaries for many platforms.