docs: init docs
All checks were successful
Build and Release / Build (darwin-arm64) (push) Successful in 19s
Build and Release / Build (darwin-amd64) (push) Successful in 20s
Build and Release / Build (linux-arm64) (push) Successful in 17s
Build and Release / Build (linux-amd64) (push) Successful in 20s
Build and Release / Build (windows-arm64) (push) Successful in 16s
Build and Release / Build (windows-amd64) (push) Successful in 19s
Build and Release / Create Release (push) Has been skipped
Deploy docs / deploy (push) Successful in 45s

This commit is contained in:
CDN 2025-04-23 14:16:16 +08:00
parent ba66894e42
commit deae4a6272
Signed by: CDN
GPG key ID: 0C656827F9F80080
20 changed files with 2887 additions and 1 deletions

View file

@ -0,0 +1,107 @@
---
title: 安装指南
description: 如何在您的系统上下载并安装 Sub-CLI
---
# 安装指南
按照以下简单步骤,在您的计算机上安装并运行 Sub-CLI。
## 下载正确的版本
Sub-CLI 适用于各种操作系统和架构。访问[发布页](https://git.owu.one/wholetrans/sub-cli/releases)下载适合您系统的版本。
### 了解应下载哪个版本
发布文件的命名遵循以下模式:
```
sub-cli-[操作系统]-[架构][.exe]
```
其中:
- **操作系统**是您的操作系统windows, darwin, linux
- **架构**是您计算机的处理器类型amd64, arm64
- `.exe`扩展名仅适用于Windows版本
### 我需要哪个版本?
以下是一个简单的选择指南:
| 操作系统 | 处理器类型 | 下载文件 |
|------------------|----------------|---------------|
| Windows | Intel/AMD大多数PC | `sub-cli-windows-amd64.exe` |
| Windows | ARM如Surface Pro X等 | `sub-cli-windows-arm64.exe` |
| macOS | Intel Mac | `sub-cli-darwin-amd64` |
| macOS | Apple SiliconM系列处理器 | `sub-cli-darwin-arm64` |
| Linux | Intel/AMD大多数PC/服务器) | `sub-cli-linux-amd64` |
| Linux | ARM树莓派基于ARM的VPS等 | `sub-cli-linux-arm64` |
如果您不确定系统架构大多数现代计算机使用amd64也称为x86_64架构。
## 安装步骤
::: tip
如果只想临时使用,您只需将 sub-cli 放在当前目录或你期望的位置,无需将其加入环境变量。
:::
### Windows
1. 从发布页面下载适合的`.exe`文件
2. 将文件移动到您选择的位置(例如,`C:\Users\[用户名]\bin\`
3. 可选将该文件夹添加到PATH环境变量中以便从任何位置运行Sub-CLI
- 右键点击"此电脑"并选择"属性"
- 点击"高级系统设置"
- 点击"环境变量"
- 在"系统变量"下,找到"Path"变量,选择它并点击"编辑"
- 点击"新建"并添加包含Sub-CLI可执行文件的文件夹路径
- 点击所有对话框上的"确定"保存更改
### macOS (Darwin)
1. 从发布页面下载适合的文件
2. 打开终端
3. 使用以下命令使文件可执行:
```bash
chmod +x path/to/downloaded/sub-cli-darwin-[架构]
```
4. 可选将其移动到PATH中的位置以便更容易访问
```bash
sudo mv path/to/downloaded/sub-cli-darwin-[架构] ~/.local/bin/sub-cli
```
### Linux
1. 从发布页面下载适合的文件
2. 打开终端
3. 使用以下命令使文件可执行:
```bash
chmod +x path/to/downloaded/sub-cli-linux-[架构]
```
4. 可选将其移动到PATH中的位置以便更容易访问
```bash
sudo mv path/to/downloaded/sub-cli-linux-[架构] ~/.local/bin/sub-cli
```
## 验证安装
要验证Sub-CLI是否正确安装打开命令提示符或终端并运行
```bash
sub-cli version
```
您应该看到显示的Sub-CLI当前版本号。
## 故障排除
如果在安装过程中遇到任何问题:
- 确保您已下载适合您操作系统和架构的正确版本
- 确保文件具有可执行权限在macOS和Linux上
- 验证文件位于命令提示符或终端可访问的位置
- 如果您已将其添加到PATH中尝试重启命令提示符或终端
如需进一步帮助,请访问我们的[反馈页面](/zh-Hans/feedback)报告问题。