跳到主要内容

配置

Cleanr 使用严格校验的 TOML 配置。第一次运行通常不需要创建文件,因为程序内置 了合理的默认值。

查找或创建配置

打印当前平台的默认配置路径:

cleanr config path

创建默认文件,但不覆盖已有配置:

cleanr config init

只有确定要替换现有文件时才使用 --force

cleanr config init --force

单次运行使用其他文件:

cleanr --config ./cleanr.toml ~/projects

默认配置

[scan]
stay_on_filesystem = false
ignore_dirs = []
ignore_patterns = ["**/.git", "**/.git/**"]
global_kinds = ["developer-caches", "browser-caches", "app-caches", "temp-files", "logs", "downloads"]

[cleanup]
default_action = "trash"
require_confirm = true
enabled_rule_packs = ["builtin-dev", "builtin-general", "builtin-system"]

[recommendations]
preselect_after_days = 90

[plugins]
# dirs 默认指向平台配置目录下的 cleanr/plugins
trusted = []

[i18n]
# locale 依次读取 LC_ALL、LC_MESSAGES、LANG,最后回退到 en-US
# locale = "zh-CN"
# dirs 默认指向平台配置目录下的 cleanr/languages

[ui]
# "auto" 检测终端背景,也可以显式使用 "dark" 或 "light"
theme = "auto"

从命令行修改常用配置

可以直接编辑 TOML,也可以使用点号键名:

cleanr config get ui.theme
cleanr config set ui.theme dark
cleanr config set scan.stay_on_filesystem true
cleanr config set cleanup.require_confirm false
cleanr config set recommendations.preselect_after_days 180
cleanr config set i18n.locale zh-CN

布尔值支持 true/falseyes/noon/off1/0。未知键或 无效值会被拒绝,不会替换原本有效的配置。

配置参考

[scan]

选项默认值说明
stay_on_filesystemfalsetrue 时不跨文件系统边界
ignore_dirs[]需要跳过的精确目录路径
ignore_patternsGit 元数据 glob同时匹配绝对路径和根目录相对路径的 glob
global_kinds全部内置分类/scan --global 使用的系统清理分类

已知绝对目录适合放入 ignore_dirs,重复出现的目录名或布局适合使用 ignore_patterns

[scan]
ignore_dirs = ["/home/me/projects/large-fixture"]
ignore_patterns = ["**/.git/**", "**/vendor/**", "**/.venv/**"]

[cleanup]

选项默认值说明
default_action"trash"清理动作,目前仅支持 "trash"
require_confirmtrue本地用户直接清理前是否弹出确认
enabled_rule_packs内置规则包需要加载的规则包 ID

关闭确认只会改变对话框,执行层仍要求本地用户操作。详见 安全与恢复

[recommendations]

选项默认值说明
preselect_after_days90用于确定性预选的观测修改时间年龄门槛;0 会关闭年龄门槛,接受 13650 的值

这是一项共享策略:TUI、cleanr analyzecleanr plancleanr dry-run 都会 使用它。年龄基于观测到的修改时间元数据,而不是已经证实的最后访问时间。时间缺失、 未来时间、部分或不完整的证据仍会阻止自动预选。

外部本地 AI 工具

Cleanr 不内置模型、Provider、endpoint 或 API Key 配置。同一台机器上的外部 Agent 可以读取只读的 cleanr analyze JSON 契约,但不会因此获得清理能力。报告 包含配置中的推荐策略快照和真实本地路径,不能作为安全的远程分享格式;交给其他工具前 请先阅读证据与隐私

[plugins]

选项默认值说明
dirs平台 Cleanr 插件目录存放插件 bundle 或旧版规则文件的目录
trusted[]允许预选高置信度候选项的插件 ID

信任第三方 bundle 前请先阅读插件

[i18n]

选项默认值说明
locale环境变量,最后为 en-US当前语言,例如 en-USzh-CN
dirs平台 Cleanr 语言目录存放语言 YAML 文件的目录

cleanr init --locale zh-CN 会安装内置语言文件并更新这些设置。

[ui]

选项默认值说明
theme"auto""auto""dark""light"

配置校验错误

Cleanr 会拒绝未知字段、不支持的枚举值、空 ID,以及重复的可信插件或规则包 ID。编辑后无法启动时,请使用相同的 --config 路径重新运行,并根据错误定位 字段;程序不会静默修复配置文件。