docs: more details about CLI installation

This commit is contained in:
Long Wang
2023-08-31 14:13:20 +08:00
parent caf12f6ec4
commit 30677d6417

View File

@@ -2,21 +2,38 @@
## 功能介绍
- 通过TOMLJSONYAML格式的配置文件定义MAA任务流程并通过`maa run <task>`命令执行任务。
- 通过TOMLJSONYAML格式的配置文件定义MAA任务流程并通过`maa run <task>`命令执行任务。
- 通过`maa list`命令列出所有可用任务。
- 通过`maa install``maa update`命令安装和更新MAA共享库和资源。
- 通过`maa self update`命令更新CLI自身。
## 安装
### Linux
对于最新版本的MAACLI已经打包在MAA的安装包中,无需额外安装。
对于最新版本的MAACLI已经打包在MAA压缩包中如果你下载了最新版MAA解压后就可以使用CLI,无需额外安装。
**注意**: 请不要将库文件和资源文件随便移动到其他位置否则CLI将无法找到它们。
如果你想将它们移动到其他位置,你可以通过以下命令:
```bash
# 请确保你当前的工作目录是解压后的MAA目录
lib_dir="$(./maa dir lib)"
resource_dir="$(./maa dir resource)"
mv lib* "$lib_dir"
mv resource "$resource_dir"
```
如果你当前使用的是旧版本的MAA或者希望单独安装CLI
你可以前往[CLI Release页面](https://github.com/MaaAssistantArknights/maa-cli/releases/latest)
根据你的架构下载对应的预编译的CLI二进制文件
对于x86_64架构你可以下载以`x86_64-unknown-linux-gnu.tar.gz`结尾的文件,
对于aarch64架构你可以下载以`aarch64-unknown-linux-gnu.tar.gz`结尾的文件),
解压后将`maa`文件移动到你任何在`PATH`环境变量中的目录下, 然后使用`maa install`命令安装MAA共享库和资源。
### macOS
macOS请前往[Release页面](https://github.com/MaaAssistantArknights/maa-cli/releases/latest)
下载预编译的CLI二进制文件 解压后将`maa`文件移动到你任何在`PATH`环境变量中的目录下,
然后使用`maa install`命令安装MAA共享库和资源。
macOS用户和Linux用户一样可以在[CLI Release页面](https://github.com/MaaAssistantArknights/maa-cli/releases/latest)
下载对应的预编译的CLI二进制文件macOS提供通用的二进制文件`universal-apple-darwin.tar.gz`结尾),
解压后将`maa`文件移动到你任何在`PATH`环境变量中的目录下,然后使用`maa install`命令安装MAA共享库和资源。
### Windows
@@ -28,8 +45,8 @@ CLI目前尚不支持Windows。
你的配置文件(选项,任务等)位于配置目录中,你可以通过`maa dir config`获取配置目录,
并通过`mkdir -p "$(maa dir config)"`创建它。
以下配置目录的将被称为`$MAA_CONFIG_DIR`且以下所有配置文件的格式可以是TOMLJSON或YAML
以下的介绍中,配置目录的将被称为`$MAA_CONFIG_DIR`
此外尽管所有的例子都是针对TOML格式的但是以下所有配置文件的格式可以是TOMLJSON或YAML。
### MAA选项