Skip to content

🚀 快速开始

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

1. 下载 / 部署

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

macOS用户

须阅读 macOS 部署 文档

⚠️ 自动部署流程异常相关:

①当出现403等网络问题时,②(仅限win)或自动部署之后的解压目录/bin/cgs.exe仍然不存在时...

没有部署成功 !

查看 pypi换源指引 换源部署

  • 或使用uv tool

仅使用时不建议用克隆源码方式,否则需要自行管理环境,同样需要用到 uv,那还是不如直接用 uv tool

流程:

  1. 安装 astral-sh/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
bash
uv tool install ComicGUISpider --index-url https://pypi.tuna.tsinghua.edu.cn/simple

v2.4.0 之后的绿色包均转为套壳操作 uv tool

2. 运行

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

否则为 uv tool run --from comicguispider cgs

常规 GUI 运行

cmd
cgs

或直接使用📦绿色包程序

命令行工具

cmd
cgs-cli --help

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

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

使用方法进help看说明

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

3. 配置

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

4. 更新

版本在 v2.4.0 之前的一律到 最新稳定版releases 上获取

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

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

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

  • 或直接使用 uv tool upgrade ComicGUISpider

绿色包注意事项

无论win/mac,绿色包内程序不再含 CGS 代码,所以单纯从新 release 上下载新版绿色包覆盖是没用的


mac绿色包:可用以上两种方式更新;


win绿色包可选更新方式:

  • 内置更新
  • 或删掉原解压目录的 comicguispiderbin 两个文件夹后重新运行 CGS.exe
  • 或换个解压目录安装

5. 搭配阅读器

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

点击前往redViewer

ComicGUISpider Released under the MIT License. (latest: v2.2)