Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

init

alias: i

在目标目录生成一份最小可用的配置脚手架。init 只需要 logger,不需要已有配置,因此可以在任意空目录中直接运行。

参数

参数默认值说明
-d, --dir <DIR>当前目录目标目录(不存在时自动创建,支持嵌套路径)
-f, --forcefalse覆盖已存在的文件

生成的文件

<dir>/
├── thurgio.yaml        # 主配置(setting 节)
├── provider.yaml       # provider 定义
├── filter.yaml         # 过滤规则
├── rename.yaml         # 重命名规则
├── params.yaml         # 模板参数
├── snippet.yaml        # snippet 定义
└── tpls/
    ├── base.tpl        # 最小示例模板(provider 渲染入口)
    └── ui.tpl          # Dashboard 页面模板(serve 自带 UI 依赖它,勿删除)

注意:

  • 不会生成 ruleset.yaml——它是唯一“缺失合法“的 sibling 配置文件,需要时手动创建即可(见配置参考)。
  • 任一目标文件已存在且未指定 --force 时报错退出;使用 --force 会用内置模板覆盖所有文件。
  • 生成的 provider.yaml 中带有一个指向本地示例的 provider 条目,可直接作为起点修改。

示例

# 在当前目录初始化
thurgio init

# 在指定目录初始化(目录不存在时自动创建)
thurgio init --dir ~/thurgio-config

# 已有文件时强制重新生成(覆盖为全新脚手架)
thurgio init --force