From 560bc7b093ada842ac952f7764be237cb2ea914f Mon Sep 17 00:00:00 2001 From: "injet.zhou" Date: Mon, 2 Nov 2026 11:03:02 +0800 Subject: [PATCH] =?UTF-8?q?feat(cli):=20=E6=96=B0=E5=A2=9E=E4=B8=80?= =?UTF-8?q?=E9=94=AE=E5=AE=89=E8=A3=85=E8=84=9A=E6=9C=AC=E5=B9=B6=E6=9B=B4?= =?UTF-8?q?=E6=96=B0=E5=AE=89=E8=A3=85=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 新增 scripts/install.sh:读取最新 Release,下载并校验二进制后安装 - 支持指定版本、安装目录、Gitea 仓库与私有仓库令牌,可重复执行升级 - 文档改为一条 curl 命令安装,保留手动下载说明 --- .gitea/workflows/README.md | 1 + README.md | 2 +- apps/docs/src/content/docs/cli/setup.md | 61 +++++++++- scripts/install.sh | 147 ++++++++++++++++++++++++ 4 files changed, 206 insertions(+), 5 deletions(-) create mode 100755 scripts/install.sh diff --git a/.gitea/workflows/README.md b/.gitea/workflows/README.md index 69ce12f..d16400d 100644 --- a/.gitea/workflows/README.md +++ b/.gitea/workflows/README.md @@ -121,6 +121,7 @@ docker login gitea.example.com - **触发条件**:仅 `push` + `tags: v*`;分支推送和 Pull Request 都不构建 CLI,脚本也会校验 `CI_EVENT_NAME` 与 `CI_REF`。 - **产物**:`discernlen-linux-amd64`、`discernlen-darwin-arm64` 与 `sha256sums.txt`,作为该 tag 的 Gitea Release 附件。 +- **一键安装**:[`scripts/install.sh`](../../scripts/install.sh) 读取最新 Release,下载对应附件并用 `sha256sums.txt` 校验后安装,可重复执行升级。用法见 [CLI 安装](../../apps/docs/src/content/docs/cli/setup.md)。 - **版本注入**:构建时用 `-ldflags -X` 写入 tag 与 12 位提交号,`discernlen --version` 输出 `discernlen version v1.2.3 (abc1234def567)`。 - **重跑**:同一 tag 重跑会删除并重建该 Release 及附件,避免旧附件残留;不会改动 git tag。 - **凭据**:使用 Gitea 每个 job 自动注入的 `GITEA_TOKEN`(兼容别名 `GITHUB_TOKEN`,需仓库写权限),无需额外 Secrets 或变量。 diff --git a/README.md b/README.md index 692908e..f0889e9 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ docker compose up -d --build | [快速开始](apps/docs/src/content/docs/start/quickstart.md) / [首次实验](apps/docs/src/content/docs/start/first-experiment.md) | 访问平台、选择目标与执行池、预览和提交 | | [GPU 历史对比](apps/docs/src/content/docs/guides/gpu-history.md) | 直接比较孔明工作负载的历史窗口、GPU 曲线、事件与配置,无需压测实验 | | [使用指南](apps/docs/src/content/docs/guides/) | 流程、数据与流量、运行指标、比较、助手与技能 | -| [CLI](apps/docs/src/content/docs/cli/setup.md) | 下载与校验、连接与登录、常用命令、日志与下载 | +| [CLI](apps/docs/src/content/docs/cli/setup.md) | 一键安装与升级、连接与登录、常用命令、日志与下载 | 现有内部资料继续保留:[产品设计](docs/product-design.md)、[实现说明](docs/implementation-guide.md)、[实现状态](docs/implementation-status.md)、[验收记录](docs/verification.md)。已实现能力与剩余范围以实现状态为准。 diff --git a/apps/docs/src/content/docs/cli/setup.md b/apps/docs/src/content/docs/cli/setup.md index c504cdf..d20fe57 100644 --- a/apps/docs/src/content/docs/cli/setup.md +++ b/apps/docs/src/content/docs/cli/setup.md @@ -3,9 +3,60 @@ title: 连接与登录 description: 获取 discernlen 命令行工具,登录平台并读取资源。 --- -## 获取工具 +## 一键安装 -从仓库 Releases 页面下载对应平台的二进制: +在 Linux x86_64 或 macOS(Apple Silicon)上执行: + +```sh +curl -fsSL https://git.agentwithu.com/discernlen/discernlen/raw/branch/main/scripts/install.sh | sh +``` + +脚本读取最新 Release,下载对应平台的二进制,用同版本的 `sha256sums.txt` 校验后安装到 `~/.local/bin/discernlen`。再次执行同一命令即可升级到最新版本,不会改动平台登录配置。 + +确认安装: + +```sh +discernlen --version +``` + +输出 tag 与构建提交号,例如 `discernlen version v1.2.3 (abc1234def567)`。如果提示找不到命令,将安装目录加入 `PATH`: + +```sh +export PATH="$HOME/.local/bin:$PATH" +``` + +安装指定版本、写入其他目录,或使用其他 Gitea 仓库: + +```sh +curl -fsSL https://git.agentwithu.com/discernlen/discernlen/raw/branch/main/scripts/install.sh \ + | sh -s -- --version v1.2.3 +curl -fsSL https://git.agentwithu.com/discernlen/discernlen/raw/branch/main/scripts/install.sh \ + | sh -s -- --install-dir /usr/local/bin +curl -fsSL https://git.agentwithu.com/discernlen/discernlen/raw/branch/main/scripts/install.sh \ + | sh -s -- --repo https://gitea.example.com/team/discernlen +``` + +写入 `/usr/local/bin` 需要当前用户对该目录有写权限。 + +| 参数 / 环境变量 | 用途 | +| --- | --- | +| `--version` / `DISCERNLEN_VERSION` | 安装指定版本,默认最新 Release | +| `--install-dir` / `DISCERNLEN_INSTALL_DIR` | 安装目录,默认 `~/.local/bin` | +| `--repo` / `DISCERNLEN_REPO_URL` | Gitea 仓库地址 | +| `DISCERNLEN_API_BASE` | 仓库 API 地址,默认由仓库地址推导 | +| `DISCERNLEN_TOKEN` | 私有仓库的访问令牌 | + +私有仓库需要让脚本自身的下载也携带令牌: + +```sh +export DISCERNLEN_TOKEN=... +curl -fsSL -H "Authorization: token $DISCERNLEN_TOKEN" \ + https://git.agentwithu.com/discernlen/discernlen/raw/branch/main/scripts/install.sh | sh +``` + +## 手动安装 + +无法执行安装脚本时,从 [Releases](https://git.agentwithu.com/discernlen/discernlen/releases) 下载对应平台的二进制: | 平台 | 文件 | | --- | --- | @@ -15,13 +66,15 @@ description: 获取 discernlen 命令行工具,登录平台并读取资源。 每个 `v*` tag 的 Release 同时提供 `sha256sums.txt`,下载后先校验再安装: ```sh -sha256sum -c sha256sums.txt # macOS 用 shasum -a 256 -c sha256sums.txt +grep 'discernlen-linux-amd64$' sha256sums.txt | sha256sum -c - chmod +x discernlen-linux-amd64 sudo install -m 0755 discernlen-linux-amd64 /usr/local/bin/discernlen discernlen --version ``` -`--version` 输出 tag 与构建提交号,例如 `discernlen version v1.2.3 (abc1234def567)`;可据此确认升级到了预期版本。二进制未做代码签名,macOS 首次运行若被拦截,可执行 `xattr -d com.apple.quarantine ./discernlen-darwin-arm64` 后重新校验。 +macOS 下载 `discernlen-darwin-arm64` 后,将示例中的文件名和 `sha256sum` 分别替换为 `discernlen-darwin-arm64` 和 `shasum -a 256`。 + +二进制未做代码签名,macOS 首次运行若被拦截,可执行 `xattr -d com.apple.quarantine ./discernlen-darwin-arm64` 后重新校验。 ## 连接平台 diff --git a/scripts/install.sh b/scripts/install.sh new file mode 100755 index 0000000..3f80015 --- /dev/null +++ b/scripts/install.sh @@ -0,0 +1,147 @@ +#!/bin/sh +# Install or upgrade the discernlen CLI from a Gitea release. +# +# curl -fsSL https://git.agentwithu.com/discernlen/discernlen/raw/branch/main/scripts/install.sh | sh +# curl -fsSL .../install.sh | sh -s -- --version v1.2.3 --install-dir "$HOME/bin" +set -eu + +repo_url=${DISCERNLEN_REPO_URL:-https://git.agentwithu.com/discernlen/discernlen} +api_base=${DISCERNLEN_API_BASE:-} +version=${DISCERNLEN_VERSION:-} +install_dir=${DISCERNLEN_INSTALL_DIR:-"$HOME/.local/bin"} +token=${DISCERNLEN_TOKEN:-} + +usage() { + cat <<'EOF' +安装最新的 discernlen CLI。 + +用法: + install.sh [--version TAG] [--install-dir DIR] [--repo URL] + +选项: + --version TAG 安装指定版本,默认读取最新 Release + --install-dir DIR 安装目录,默认 ~/.local/bin + --repo URL 仓库地址,默认本项目的 Gitea 仓库 + -h, --help 显示帮助 + +环境变量: + DISCERNLEN_VERSION 同 --version + DISCERNLEN_INSTALL_DIR 同 --install-dir + DISCERNLEN_REPO_URL 同 --repo + DISCERNLEN_API_BASE 仓库 API 地址,默认由仓库地址推导 + DISCERNLEN_TOKEN 访问私有仓库的令牌 +EOF +} + +fail() { + printf '错误: %s\n' "$*" >&2 + exit 1 +} + +need_value() { + [ "$#" -ge 2 ] || fail "$1 需要一个值" +} + +while [ "$#" -gt 0 ]; do + case "$1" in + --version) need_value "$@"; version=$2; shift 2 ;; + --install-dir) need_value "$@"; install_dir=$2; shift 2 ;; + --repo) need_value "$@"; repo_url=$2; shift 2 ;; + -h|--help) usage; exit 0 ;; + *) fail "未知参数 $1" ;; + esac +done + +repo_url=${repo_url%/} +repo_url=${repo_url%.git} +case "$repo_url" in + http://*|https://*) ;; + *) fail "仓库地址必须以 http:// 或 https:// 开头: $repo_url" ;; +esac + +if [ -z "$api_base" ]; then + scheme=${repo_url%%://*} + rest=${repo_url#*://} + host=${rest%%/*} + repo_path=${rest#*/} + [ "$repo_path" != "$rest" ] || fail "仓库地址缺少 owner/repo: $repo_url" + api_base="$scheme://$host/api/v1/repos/$repo_path" +fi +api_base=${api_base%/} + +os=$(uname -s | tr '[:upper:]' '[:lower:]') +case "$os" in + linux|darwin) ;; + *) fail "不支持的操作系统: $os(支持 Linux 和 macOS)" ;; +esac +arch=$(uname -m) +case "$arch" in + x86_64|amd64) arch=amd64 ;; + arm64|aarch64) arch=arm64 ;; + *) fail "不支持的架构: $arch" ;; +esac +case "$os-$arch" in + linux-amd64|darwin-arm64) ;; + *) fail "$os/$arch 暂无预编译二进制(可用: linux/amd64、darwin/arm64)" ;; +esac + +tmp_dir=$(mktemp -d "${TMPDIR:-/tmp}/discernlen-install.XXXXXX") +trap 'rm -rf "$tmp_dir"' EXIT HUP INT TERM + +fetch() { + if [ -n "$token" ]; then + curl -fsSL -H "Authorization: token $token" "$1" -o "$2" + else + curl -fsSL "$1" -o "$2" + fi +} + +if [ -z "$version" ]; then + fetch "$api_base/releases/latest" "$tmp_dir/latest.json" + version=$(sed -n 's/.*"tag_name"[[:space:]]*:[[:space:]]*"\([^"]*\)".*/\1/p' "$tmp_dir/latest.json" | head -n 1) + [ -n "$version" ] || fail "无法从 $api_base/releases/latest 读取最新版本" +fi +case "$version" in + v*) ;; + *) version="v$version" ;; +esac + +asset="discernlen-$os-$arch" +printf '正在下载 discernlen %s(%s/%s)…\n' "$version" "$os" "$arch" +fetch "$repo_url/releases/download/$version/$asset" "$tmp_dir/$asset" +fetch "$repo_url/releases/download/$version/sha256sums.txt" "$tmp_dir/sha256sums.txt" + +expected=$(awk -v name="$asset" '$2 == name || $2 == "*" name {print $1; exit}' "$tmp_dir/sha256sums.txt") +[ -n "$expected" ] || fail "sha256sums.txt 中没有 $asset 的校验值" +if command -v sha256sum >/dev/null 2>&1; then + actual=$(sha256sum "$tmp_dir/$asset" | awk '{print $1}') +elif command -v shasum >/dev/null 2>&1; then + actual=$(shasum -a 256 "$tmp_dir/$asset" | awk '{print $1}') +else + fail "需要 sha256sum 或 shasum 校验下载文件" +fi +[ "$actual" = "$expected" ] || fail "SHA-256 校验失败,未安装" + +mkdir -p "$install_dir" || fail "无法创建安装目录: $install_dir" +[ -w "$install_dir" ] || fail "没有写入 $install_dir 的权限;可改用 --install-dir \"$HOME/.local/bin\"" +target="$install_dir/discernlen" +if command -v install >/dev/null 2>&1; then + install -m 0755 "$tmp_dir/$asset" "$target" +else + cp "$tmp_dir/$asset" "$target" + chmod 0755 "$target" +fi +if [ "$os" = darwin ] && command -v xattr >/dev/null 2>&1; then + xattr -d com.apple.quarantine "$target" 2>/dev/null || true +fi + +reported=$("$target" --version) || fail "安装后无法运行 $target" +reported=$(printf '%s\n' "$reported" | head -n 1) +printf '已安装 %s 到 %s\n' "$reported" "$target" + +case ":${PATH:-}:" in + *":$install_dir:"*) ;; + *) + printf '\n提示: %s 不在 PATH 中,请将下面一行加入 shell 配置后重新打开终端:\n export PATH="%s:$PATH"\n' "$install_dir" "$install_dir" + ;; +esac