命令行帮助

您可以通过运行 embykeeper -h 以获取帮助:

$ embykeeper -h

欢迎使用 Embykeeper 🎦 无参数默认开启全部功能.

参数:
    config  配置文件 (置空以生成)
模块开关:
    --checkin       -c   启用每日签到 (不指定值时默认为6:00PM-10:00PM之间随机时间)
    --emby          -e   启用每隔天数Emby自动保活 (不指定值时默认为每3天)
    --monitor       -m   启用群聊监视
    --send          -s   启用自动水群
    (以上开关默认开启全部, 各账号根据分别的设置运行对应功能)
调试参数:
    --debug         -d   开启调试级日志 (-dd 会显示更多日志)
    --no-instant    -I   启动时不立刻执行一次任务
    --once          -o   仅执行一次任务而不计划执行
    --basedir       -B   设定账号文件和模型文件的位置
    --simple-log    -L   日志不输出时间 (部分平台自带时间记录时使用)
    --disable-color -C   日志不使用颜色 (避免部分平台不支持 ANSI 颜色码的问题)
    --version       -v   打印 Embykeeper 版本
    --save          -S   记录执行过程中的原始更新日志
调试工具:
    --follow        -F   仅启动消息调试
    --analyze       -A   仅启动历史信息分析
    --dump          -D   仅启动更新日志

参数说明

• 当有 --checkin / --emby / --monitor / --send 参数时, 仅开启对应功能, 否则开启全部功能.

  (账户层面也需要启用 monitor 和 send 才能启用监控和水群, 详见 🔧 配置文件)

  案例:

  # 启动所有功能
  embykeeper config.toml
  
  # 仅启动每日签到
  embykeeper config.toml -c
  
  # 仅启动每日签到和水群
  embykeeper config.toml -c -s

• --checkin 参数可以调整默认的签到区间 (配置文件中也可以通过 time 来调整, 优先级低于命令行)

  案例:

  # 仅启动每日 8:00 PM 签到
  embykeeper config.toml -c 8:00PM
  
  # 仅启动每日 8:00 PM - 9:00 PM 随机时间签到
  embykeeper config.toml -c <8:00PM,9:00PM>
  
  # 启动所有功能, 同时调整签到时间为每日 8:00 PM - 9:00 PM
  embykeeper config.toml -c <8:00PM,9:00PM> -e -m -s

• --emby 参数可以调整 Emby 保活的间隔天数 (配置文件中也可以通过 interval 来调整, 优先级低于命令行)

  案例:

  # 启动所有功能, 同时调整 Emby 保活每天运行一次
  embykeeper config.toml -e 1 -c -m -s

• 为了防止调试时反复签到引起怀疑, 您可能需要使用 -I 参数运行, 每次启动运行后不再立刻运行一次签到和保活.

• 当你发现程序出现问题, 请您使用 -d 参数运行, 此时程序将提供更多的日志信息, 方便问题的调试.

• 部分命令行参数可以通过环境变量调整, 优先级低于命令行:

  参数	环境变量
  EK_CONFIG_FILE	配置文件
  EK_INSTANT	--instant
  EK_DEBUG	--debug

Docker 部署使用命令行参数

当通过 Docker 部署时, 末尾的所有参数将被传递给 Embykeeper, 例如:

docker run -v $(pwd)/embykeeper:/app --rm -it --net=host embykeeper/embykeeper -I

当通过 Docker Compose 部署时, 您需要通过修改 docker-compose.yml 中的 command 项, 从而调整命令行参数, 例如:

version: '3'
services:
  embykeeper:
    container_name: embykeeper
    image: embykeeper/embykeeper
    command: '-I'
    restart: unless-stopped
    volumes:
      - ./embykeeper:/app
    network_mode: host