Skip to content
yumenaka edited this page Apr 28, 2026 · 1 revision

05 CLI 模式

CLI 模式适合服务器、SSH、脚本启动和临时阅读目录。

基本格式:

comi [flags] file_or_dir

如果不指定路径,ComiGo 会把当前工作目录作为书库:

comi

指定一个目录:

comi /path/to/books

指定多个目录:

comi /path/to/books /path/to/more-books

常用参数

参数 默认值 说明
--port, -p 1234 Web 服务端口
--host 0.0.0.0 监听地址
--local false 只允许本机访问
--open-browser, -o false 启动后自动打开浏览器
--config, -c 指定配置文件
--username 登录用户名
--password 登录密码
--read-only false 禁止上传和修改类操作
--enable-upload true 启用上传页面
--max-depth, -m 5 最大扫描深度
--min-image 1 一个目录至少包含多少图片才识别为书
--auto-rescan-min 0 自动重新扫描间隔,0 表示关闭
--lang auto 语言,例如 zh, en, ja
--base-path 反向代理子路径
--debug false 调试模式
--upgrade, -u false 自升级

查看完整参数:

comi --help

常见启动示例

只在本机阅读:

comi --local /path/to/books

允许局域网设备访问:

comi --host 0.0.0.0 /path/to/books

设置账号密码:

comi --username admin --password your_password /path/to/books

指定端口:

comi -p 8080 /path/to/books

中文界面:

comi --lang zh /path/to/books

只读模式:

comi --read-only /path/to/books

定时重新扫描:

comi --auto-rescan-min 10 /path/to/books

反向代理在二级目录:

comi --base-path /comigo /path/to/books

升级当前 CLI:

comi -u

TUI

部分版本提供命令行界面,用于在终端里查看和管理服务状态。

ComiGo TUI

TUI 适合 SSH、服务器和不方便打开浏览器管理页的场景。它不是阅读界面,主要用于运行与管理。

环境变量

ComiGo 支持 COMIGO_ 前缀环境变量。它们通常和配置项名称对应。

示例:

COMIGO_PORT=8080 COMIGO_LANGUAGE=zh comi /path/to/books

Docker 和 systemd 部署时,环境变量会比手写命令参数更方便。

systemd 长期运行

仓库中提供了示例:

sample/systemd/comigo.service

常见流程:

sudo cp sample/systemd/comigo.service /etc/systemd/system/
sudo systemctl daemon-reload
sudo systemctl enable comigo
sudo systemctl start comigo

查看日志:

journalctl -u comigo -f

Clone this wiki locally