admin
e6956aa001
- React frontend with route-level code splitting - Backend rebranded from Baihu to TaskPool - DB brand migration script and local compatibility
167 lines
6.4 KiB
Markdown
167 lines
6.4 KiB
Markdown
# 命令行工具 (CLI)
|
||
|
||
taskpool在环境内内置了同名的 `taskpool` 命令行工具。如果您在终端内需要执行系统级别的操作，可以使用这些内置命令。
|
||
|
||
## 常用核心指令
|
||
|
||
| 命令 | 描述 |
|
||
| :--- | :--- |
|
||
| `taskpool server` | 面板启动指令，运行服务端后台进程。 |
|
||
| `taskpool reposync` | 供定时任务调用，将远程 Git 仓库的高级特性同步到本地目录中。 |
|
||
| `taskpool resetpwd` | 交互式重置系统 admin 账号密码（密码丢失时可通过进入终端重置）。 |
|
||
| `taskpool restore <file>` | 使用本地的 .zip 备份压缩包文件，一条命令直接全量恢复系统数据。 |
|
||
| `taskpool task` | 极速只读与控制台常驻任务管理（支持查询列表、手动触发、查看状态及开关控制）。 |
|
||
|
||
---
|
||
|
||
## 使用场景示例
|
||
|
||
### 1. 密码重置
|
||
您可以进入 Docker 容器或通过 ssh 连入宿主机控制台：
|
||
```bash
|
||
docker exec -it taskpool taskpool resetpwd
|
||
```
|
||
然后根据提示，输入新的管理员密码即可重置成功。
|
||
|
||
### 2. 手动启动
|
||
如果是通过手动部署二进制文件，可以使用 `taskpool server` 启动：
|
||
```bash
|
||
nohup ./taskpool server > /dev/null 2>&1 &
|
||
```
|
||
|
||
### 3. 数据恢复
|
||
上传备份后的 ZIP 文件至容器目录：
|
||
```bash
|
||
docker exec -it taskpool taskpool restore /app/data/backup-2026xxxx.zip
|
||
```
|
||
该操作会全量覆盖现有数据库和脚本文件，请谨慎操作。
|
||
|
||
---
|
||
|
||
## `reposync` 参数详解
|
||
|
||
`taskpool reposync` 是面板核心的同步命令，除了在任务中自动调用外，您也可以通过命令行手动执行。
|
||
|
||
### 参数列表
|
||
|
||
| 参数名 | 默认值 | 描述 |
|
||
| :--- | :--- | :--- |
|
||
| `--source-type` | `git` | 同步源类型，可选 `git`（Git 仓库）或 `url`（文件直链下载）。 |
|
||
| `--source-url` | | 同步源地址，Git 仓库地址或下载 URL。 |
|
||
| `--target-path` | | 目标保存路径。支持变量替换（如 `$SCRIPTS_DIR$`）。 |
|
||
| `--branch` | | Git 分支名。留空时将自动检测远程默认分支（如 `main` 或 `master`）。 |
|
||
| `--path` | | 稀疏检出（Sparse checkout）的指定路径，或在单文件模式下的相对路径。 |
|
||
| `--single-file` | `false` | 是否开启单文件模式，仅从 Git 提取指定单个文件。 |
|
||
| `--proxy` | `none` | Github 加速代理类型，可选 `none`、`ghproxy`、`mirror`、`custom`。 |
|
||
| `--proxy-url` | | 自定义代理地址，仅在 `--proxy=custom` 时生效。 |
|
||
| `--auth-token` | | 私有仓库或 API 访问使用的鉴权 Token。 |
|
||
| `--http-proxy` | | HTTP/HTTPS 代理地址，例如 `http://127.0.0.1:7890`。 |
|
||
| `--whitelist-paths`| | 白名单路径（逗号或竖线分隔），同步时受保护不被清理的路径。 |
|
||
| `--blacklist` | | 黑名单关键字（竖线 `\|` 分隔），包含该关键字的文件将会被过滤删除。 |
|
||
| `--dependence` | | 依赖文件关键字（竖线 `\|` 分隔），这些文件将强制保留。 |
|
||
| `--extensions` | | 允许的脚本扩展名（竖线 `\|` 分隔，如 `.js\|.py`），后缀不符的文件将被删除。 |
|
||
| `--task-id` | | 内部任务 ID，用于在同步完成后通知调度器刷新增量任务。 |
|
||
| `--task-langs` | | 任务配置的语言（JSON格式），用于标记和解析。 |
|
||
| `--repo-task-id` | | 原始任务 ID。 |
|
||
| `--task-timeout` | `30` | 同步任务的超时时间，单位为分钟。 |
|
||
| `--commenttotask` | `false` | 是否启用青龙 (QL) 格式的脚本注释解析（`true`/`false`）。 |
|
||
|
||
### 使用示例
|
||
|
||
#### 1. 基础 Git 仓库同步
|
||
将指定仓库克隆或拉取到特定目录：
|
||
```bash
|
||
taskpool reposync --source-url https://github.com/example/repo.git --target-path /app/data/scripts/example_repo
|
||
```
|
||
|
||
#### 2. 启用代理的同步
|
||
针对 Github 仓库使用加速代理，并限定只保留 `.js` 和 `.py` 脚本：
|
||
```bash
|
||
taskpool reposync --source-url https://github.com/example/repo.git \
|
||
--target-path /app/data/scripts/example_repo \
|
||
--proxy ghproxy \
|
||
--extensions ".js|.py"
|
||
```
|
||
|
||
#### 3. 稀疏检出 (Sparse Checkout)
|
||
当仓库庞大时，仅同步特定的子目录或文件：
|
||
```bash
|
||
taskpool reposync --source-url https://github.com/example/repo.git \
|
||
--target-path /app/data/scripts/example_repo \
|
||
--path "scripts/daily"
|
||
```
|
||
|
||
#### 4. 单文件下载模式
|
||
如果只需要仓库中的某一个脚本文件：
|
||
```bash
|
||
taskpool reposync --source-url https://github.com/example/repo.git \
|
||
--target-path /app/data/scripts/ \
|
||
--single-file true \
|
||
--path "main_script.py"
|
||
```
|
||
|
||
#### 5. 高级过滤与青龙注释解析
|
||
使用黑名单排除特定脚本，并开启青龙格式注释解析以自动生成定时任务：
|
||
```bash
|
||
taskpool reposync --source-url https://github.com/example/repo.git \
|
||
--target-path /app/data/scripts/example_repo \
|
||
--blacklist "test|mock" \
|
||
--dependence "package.json|requirements.txt" \
|
||
--commenttotask "true"
|
||
```
|
||
|
||
---
|
||
|
||
## `taskpool task` 任务管理指令集
|
||
|
||
`taskpool task` 是一组专为纯终端操作与自动化脚本调度打造的轻量级任务管理子命令集。它能够绕过繁重的界面操作，直接提供闪电般的本地查询与安全指令下发控制。
|
||
|
||
### 支持子命令
|
||
|
||
#### 1. 任务列表查询 (`list`)
|
||
查询并分页展示系统内配置的所有任务概览。
|
||
```bash
|
||
# 默认展示前 20 条
|
||
taskpool task list
|
||
|
||
# 指定关键词过滤，并查看第 2 页 (每页展示 10 条)
|
||
taskpool task list -q "签到" -page 2 -size 10
|
||
```
|
||
|
||
#### 2. 手动立即触发 (`run`)
|
||
手动向常驻后台服务下发指令，立即异步运行指定的任务。
|
||
```bash
|
||
taskpool task run a1b2c3d4
|
||
```
|
||
|
||
#### 3. 任务状态切换 (`enable` / `disable`)
|
||
快速启用或禁用系统任务。
|
||
```bash
|
||
taskpool task enable a1b2c3d4
|
||
taskpool task disable a1b2c3d4
|
||
```
|
||
|
||
#### 4. 实时执行状态追踪 (`status`)
|
||
查看指定任务最新一次执行的详细输出日志和最终退出码。
|
||
```bash
|
||
# 查看最近一条日志
|
||
taskpool task status a1b2c3d4
|
||
|
||
# 查看指定历史日志条目的完整输出
|
||
taskpool task status a1b2c3d4 log_123456
|
||
```
|
||
|
||
#### 5. 近期执行历史流水 (`history`)
|
||
列出某任务最近的多次运行记录（包含耗时、执行时间及状态结果）。
|
||
```bash
|
||
taskpool task history a1b2c3d4
|
||
```
|
||
|
||
> [!TIP]
|
||
> 所有的 `taskpool task` 子命令均原生支持单独传入 `--help` 参数获取具体的示例和选项清单。例如：`taskpool task list --help`。
|
||
|
||
---
|
||
|
||
## 其他帮助
|
||
终端内直接执行 `taskpool` 即可在控制台直接打印内置支持详细说明和命令列表参数。
|