From 22b9afdd2aa806b85b18618d5d4d0f6a8b4f97d0 Mon Sep 17 00:00:00 2001 From: LM Date: Fri, 23 Oct 2026 12:58:49 +0800 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20README=20=E4=B8=8E=20mcp.md=20?= =?UTF-8?q?=E8=A1=A5=E5=85=85=20Homebrew=20=E5=AE=89=E8=A3=85=E6=96=B9?= =?UTF-8?q?=E5=BC=8F?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit sctl 已能通过 scriptscat/tap 安装,README(中英)在安装一节加上 brew 命令;mcp.md 作为安装细节的归属文档, 说明 formula 从源码包构建、附带补全、用 brew upgrade 升级、预发布不进 tap。英文 README 里的 installer 改称 install script,避免与 Homebrew 混淆。 --- README.md | 8 +++++++- docs/README_zh-CN.md | 6 ++++++ docs/mcp.md | 8 ++++++++ 3 files changed, 21 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2fa6b7f..76910e0 100644 --- a/README.md +++ b/README.md @@ -43,13 +43,19 @@ macOS and Linux: curl -fsSL https://raw.githubusercontent.com/scriptscat/sctl/main/scripts/install.sh | sh ``` +Homebrew: + +```bash +brew install scriptscat/tap/sctl +``` + Windows PowerShell: ```powershell irm https://raw.githubusercontent.com/scriptscat/sctl/main/scripts/install.ps1 | iex ``` -The installer verifies the release archive's sha256 and installs `sctl` into `~/.local/bin` (macOS/Linux) or +The install script verifies the release archive's sha256 and installs `sctl` into `~/.local/bin` (macOS/Linux) or `%LOCALAPPDATA%\sctl\bin` (Windows). Pinning a version, manual downloads, and building from source are covered in [`docs/mcp.md`](./docs/mcp.md#1-install-sctl). diff --git a/docs/README_zh-CN.md b/docs/README_zh-CN.md index 88f0b4b..5ccdd8d 100644 --- a/docs/README_zh-CN.md +++ b/docs/README_zh-CN.md @@ -37,6 +37,12 @@ macOS 和 Linux: curl -fsSL https://raw.githubusercontent.com/scriptscat/sctl/main/scripts/install.sh | sh ``` +Homebrew: + +```bash +brew install scriptscat/tap/sctl +``` + Windows PowerShell: ```powershell diff --git a/docs/mcp.md b/docs/mcp.md index b924ef6..165eca5 100644 --- a/docs/mcp.md +++ b/docs/mcp.md @@ -33,6 +33,14 @@ verifies its sha256 against `checksums.txt`, installs `sctl` into `~/.local/bin` not on it — it never edits your shell profile or user PATH for you. `SCTL_VERSION` pins a specific version; `SCTL_INSTALL_DIR` overrides the install directory. +With Homebrew, install from the [scriptscat/tap](https://github.com/scriptscat/homebrew-tap) tap instead; the +formula builds sctl from the release's source tarball and installs shell completions, and `brew upgrade sctl` +picks up new releases. Prereleases are not published to the tap. + +```bash +brew install scriptscat/tap/sctl +``` + To install manually instead, download the matching `sctl---.` archive from [GitHub Releases](https://github.com/scriptscat/sctl/releases), extract it, and put the `sctl` executable on `PATH`. If no published release is available, contributors can build sctl from source.