🚀 快速上手

⚠️ CGS 代码/解压的路径不能含有中文/中标

1. 下载 / 部署

• 直接下载 📦绿色包，并解压，初次打开应用时会进入自动部署流程

macOS用户

须阅读 macOS 部署 文档

⚠️ 自动部署流程异常处理方法 (仅win绿色包)

点击展开

• 参考解压包内的 异常处理提示.txt
• 开终端参考./CGS.exe --help，使用参数重新部署，例子：下方更新第三种方法

• 或使用uv tool

‼️⚠️ v2.5.2~后，发现依赖 pillow-avif 跟 python3.14 暂不兼容，

需要注意自行准备环境如 python3.13

uv tool 细节部署流程（点击展开）：

1. 安装 uv，使用 brew 安装最简单，或者使用官方的 远程安装脚本
2. （可选）设置 uv tool 的环境变量，否则 win 会默认装在C盘上
   win: 新建用户级的环境变量，设置后需开新终端窗口生效
    UV_TOOL_DIR(uv tool安装项目的位置),
    UV_TOOL_BIN_DIR(uv编译执行程序的放置位置)
   mac(示例zsh): echo "export UV_TOOL_DIR=放置tool的位置" >> ~/.zshrc,
    UV_TOOL_BIN_DIR同理操作，source ~/.zshrc后生效
   最后执行 uv tool update-shell 更新进 PATH，之后新终端窗口可直接运行 cgs / cgs-cli
3. uv tool 安装 CGS

uv tool install ComicGUISpider --index-url https://pypi.tuna.tsinghua.edu.cn/simple --python "<3.14"

可以选择 uv 中更轻量化的 uvx，命令为部署运行一体化

uvx comicguispider --python "<3.14"

两者区别在于 uvx 为临时/一次性的虚拟环境，uv tool 方式为持久化

若需要用 git 克隆源码方式，需要自行管理环境 uv sync

2. 运行

以下非绿色包命令均基于已执行 uv tool update-shell

否则为 uv tool run --from comicguispider cgs

常规 GUI 运行

cgs

或直接使用📦绿色包程序

命令行工具

cgs-cli --help

或使用绿色包的环境，在解压目录打开终端执行

.\bin\cgs-cli.exe --help

使用方法进help看说明

当前版本能进行简单下载/调试功能（后续将逐步扩展）
命令行工具的配置可用GUI方式修改 或 直接修改conf.yml文件（📒3-配置系文件路径）

3. 配置

有自定义需求的，参考 🔨主配置文档 进行设置

4. 更新

• CGS 内置了更新模块，能在配置窗口中点击 检查更新 按钮进行更新

当 本地版本 < 最新稳定版 < 最新开发版 时

需更新到最新稳定版后，才能更新到最新开发版

• 或 uv tool 管理的指定版本，例如 2.5.0

uv tool install ComicGUISpider==2.5.0 --force --index-url https://pypi.tuna.tsinghua.edu.cn/simple --python "<3.14"

• 或 win-绿色包 安装指定版本，例如 2.5.0

.\CGS.exe -v 2.5.0 -i https://pypi.tuna.tsinghua.edu.cn/simple

5. 搭配阅读器

欢迎尝试使用 redViewer ，最适 CGS ！也希望能提供有创意的功能想法给 rV ！💑