From 8bbd104ea623b95f51aeca9d0499f01446b3aec5 Mon Sep 17 00:00:00 2001 From: SherkeyXD <57581480+SherkeyXD@users.noreply.github.com> Date: Mon, 20 Oct 2025 22:18:51 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E5=88=A9=E7=94=A8tabs=E4=BC=98?= =?UTF-8?q?=E5=8C=96=E8=A7=86=E8=A7=89=E8=A1=A8=E7=8E=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/zh-cn/manual/cli/install.md | 171 ++++++++++++++++++++----------- 1 file changed, 114 insertions(+), 57 deletions(-) diff --git a/docs/zh-cn/manual/cli/install.md b/docs/zh-cn/manual/cli/install.md index 0c6ed909cf..e83761ad25 100644 --- a/docs/zh-cn/manual/cli/install.md +++ b/docs/zh-cn/manual/cli/install.md @@ -15,69 +15,110 @@ maa-cli 提供多种方式安装，包括包管理器、预编译二进制文件 Homebrew 用户可以通过非官方的 [tap](https://github.com/MaaAssistantArknights/homebrew-tap/) 安装 maa-cli： -- 稳定版本： +::: code-tabs - ```bash - brew install MaaAssistantArknights/tap/maa-cli - ``` +@tab:active 稳定版 +```bash :no-line-numbers +brew install MaaAssistantArknights/tap/maa-cli +``` -- 不稳定预发行版本： +@tab 不稳定版/预发行版 +```bash :no-line-numbers +brew install MaaAssistantArknights/tap/maa-cli-beta +``` - ```bash - brew install MaaAssistantArknights/tap/maa-cli-beta - ``` +::: ### Linux -- Arch Linux 用户可以安装 [AUR 包](https://aur.archlinux.org/packages/maa-cli/)： +我们目前为 Arch 和 Nix 用户提供预编译基于包管理器的分发支持 - ```bash - yay -S maa-cli - ``` +#### Arch Linux -- ❄️ Nix 用户可以直接运行: +可以安装 [AUR 包](https://aur.archlinux.org/packages/maa-cli/)： - ```bash - # 稳定版 - nix run nixpkgs#maa-cli - ``` +::: code-tabs - ```bash - # 每夜构建 - nix run github:Cryolitia/nur-packages#maa-cli-nightly - ``` +@tab:active paru +```bash :no-line-numbers +paru -S maa-cli +``` - 稳定版打包至 [nixpkgs](https://github.com/NixOS/nixpkgs/blob/nixos-unstable/pkgs/by-name/ma/maa-cli/package.nix) 中，使用 `nixpkgs` 中的 Rust 工具链；每夜构建位于 [NUR](https://github.com/Cryolitia/nur-packages/blob/master/pkgs/maa-assistant-arknights/maa-cli.nix) 中，使用 Beta channel 的 Rust 工具链，由 Github Action 每日自动更新和构建验证。 +@tab yay +```bash :no-line-numbers +yay -S maa-cli +``` -- 对于在 Linux 上使用 Homebrew 的用户，参见上述 macOS 的安装方式。 +::: + +#### ❄️ Nix + +用户可以直接运行: + +::: code-tabs + +@tab:active 稳定版 +```bash :no-line-numbers +nix run nixpkgs#maa-cli +``` + +@tab 每夜构建 +```bash :no-line-numbers +nix run github:Cryolitia/nur-packages#maa-cli-nightly +``` + +::: + +稳定版打包至 [nixpkgs](https://github.com/NixOS/nixpkgs/blob/nixos-unstable/pkgs/by-name/ma/maa-cli/package.nix) 中，使用 `nixpkgs` 中的 Rust 工具链；每夜构建位于 [NUR](https://github.com/Cryolitia/nur-packages/blob/master/pkgs/maa-assistant-arknights/maa-cli.nix) 中，使用 Beta channel 的 Rust 工具链，由 Github Action 每日动更新和构建验证 + +#### 其他发行版 + +对于在 Linux 上使用 Homebrew 的用户，请参见上述 macOS 的安装方式。 + +否则，请 [使用预编译二进制文件](#预编译二进制文件) 或是 [自行编译安装](#编译安装) + +我们也欢迎各位有兴趣的开发者将 maa-cli 提交到更多发行版的官方仓库或是用户仓库！ ## 预编译二进制文件 如果你的系统不受支持或者不想使用包管理器，你可以点击以下链接下载对应平台的预编译二进制文件，解压后将可执行文件放入 `PATH` 中即可使用。 -- [macOS](https://github.com/MaaAssistantArknights/maa-cli/releases/latest/download/maa_cli-universal-apple-darwin.zip) -- [Linux x86_64 (x64, amd64)](https://github.com/MaaAssistantArknights/maa-cli/releases/latest/download/maa_cli-x86_64-unknown-linux-gnu.tar.gz) -- [Linux aarch64 (arm64)](https://github.com/MaaAssistantArknights/maa-cli/releases/latest/download/maa_cli-aarch64-unknown-linux-gnu.tar.gz) -- [Windows x86_64 (x64, amd64)](https://github.com/MaaAssistantArknights/maa-cli/releases/latest/download/maa_cli-x86_64-pc-windows-msvc.zip) -- [Windows aarch64 (arm64)](https://github.com/MaaAssistantArknights/maa-cli/releases/latest/download/maa_cli-aarch64-pc-windows-msvc.zip) +::: tabs#pre-compile -如果你的平台不在上述列表中，可以尝试自行编译安装（参见下文）。 +@tab:active macOS +[前往下载](https://github.com/MaaAssistantArknights/maa-cli/releases/latest/download/maa_cli-universal-apple-darwin.zip) + +@tab Linux +请选择你的架构 ++ [x64/x86_64/amd64](https://github.com/MaaAssistantArknights/maa-cli/releases/latest/download/maa_cli-x86_64-unknown-linux-gnu.tar.gz) ++ [aarch64/arm64)](https://github.com/MaaAssistantArknights/maa-cli/releases/latest/download/maa_cli-aarch64-unknown-linux-gnu.tar.gz) + +@tab Windows +请选择你的架构 ++ [x64/x86_64/amd64](https://github.com/MaaAssistantArknights/maa-cli/releases/latest/download/maa_cli-x86_64-pc-windows-msvc.zip) ++ [aarch64/arm64)](https://github.com/MaaAssistantArknights/maa-cli/releases/latest/download/maa_cli-aarch64-pc-windows-msvc.zip) + +::: + +如果你的平台不在上述列表中，可以尝试自行编译安装（参见下文） ## 编译安装 Rust 开发者可以通过 `cargo` 自行编译安装 maa-cli： -- 稳定版本： +::: code-tabs - ```bash - cargo install --git https://github.com/MaaAssistantArknights/maa-cli.git --bin maa --tag stable --locked - ``` +@tab:active 稳定版本 +```bash :no-line-numbers +cargo install --git https://github.com/MaaAssistantArknights/maa-cli.git --bin maa --tag stable --locked +``` -- 开发版本： +@tab 开发版本 +```bash :no-line-numbers +cargo install --git https://github.com/MaaAssistantArknights/maa-cli.git --bin maa --locked +``` - ```bash - cargo install --git https://github.com/MaaAssistantArknights/maa-cli.git --bin maa --locked - ``` +::: ### 编译选项 @@ -90,36 +131,52 @@ Rust 开发者可以通过 `cargo` 自行编译安装 maa-cli： ## 安装 MaaCore 及资源 +::: warning +只有使用包管理器安装 maa-cli 的用户才能使用包管理器安装 MaaCore，否则请使用 `maa install` 命令安装 +此外，`maa install` 下载的是官方预编译的 MaaCore，而包管理器安装的 MaaCore 可能使用与官方预编译版本不同的编译选项和依赖版本，这也许会导致性能和功能上的略微差异 +::: + maa-cli 只提供了一个命令行界面，它需要 MaaCore 和资源来运行任务。一旦 maa-cli 安装完成，你可以通过它安装 MaaCore 及资源： -```bash +```bash :no-line-numbers maa install ``` -对于 Windows 平台用户，在运行 `maa install` 命令前，请以管理员身份在命令提示符或PowerShell中运行以下命令，以安装必要工具组VC++ +根据不同的平台，你的操作也有所区别 -- Windows: +::: tabs#maacore - ```bat - winget install "Microsoft.VCRedist.2015+.x64" --override "/repair /passive /norestart" --uninstall-previous --accept-package-agreements --force +@tab Windows +对于 Windows 平台用户，在运行 `maa install` 命令前，请以管理员身份在命令提示符或PowerShell中运行以下命令，以安装必要工具组 VC++ + +```bat :no-line-numbers +winget install "Microsoft.VCRedist.2015+.x64" --override "/repair /passive /norestart" --uninstall-previous --accept-package-agreements --force +``` + +然后再运行 `maa install` + +@tab Homebrew +你可以直接通过 Homebrew 安装 maa-core +```bash :no-line-numbers +brew install MaaAssistantArknights/tap/maa-core +``` + +@tab Arch + 你可以通过 [AUR](https://aur.archlinux.org/packages/maa-assistant-arknights/) 安装 maa-core + ::: code-tabs + + @tab:active paru + ```bash :no-line-numbers + paru -S maa-assistant-arknights ``` -对于使用包管理器安装的用户，可以通过包管理器安装 MaaCore： - -- Homebrew： - - ```bash - brew install MaaAssistantArknights/tap/maa-core - ``` - -- Arch Linux： - - ```bash + @tab yay + ```bash :no-line-numbers yay -S maa-assistant-arknights ``` + ::: -- Nix： +@tab Nix +Nix 上的 maa-cli 强制依赖 MaaCore，因此 Nix 用户无需，也不应该手动安装 MaaCore - Nix 上的 maa-cli 强制依赖 MaaCore。 因此，Nix 用户无需，也不应该手动安装 MaaCore。 - -**注意**：只有使用包管理器安装 maa-cli 的用户才能使用包管理器安装 MaaCore，否则请使用 `maa install` 命令安装。此外，`maa install` 通过下载官方预编译的 MaaCore，而包管理器安装的 MaaCore 可能使用的编译选项和依赖版本与官方预编译的版本不同，这可能导致性能和功能上存在略微差异。 +:::