完整字段参考
本页是面向最终用户的、涵盖 Entry Web UI 每一个输入和控件的权威字段参考。
如何阅读本参考
每个字段都列出:
- 配置键(Config key) — 配置文件和 CLI 中使用的键
- 控件(Control) — 输入类型
- 默认值(Default) — 安全的默认值
- 风险(Risk) —
normal、caution或risky - 说明(Notes) — 该字段的作用以及何时更改它
Core
| 配置键 | 控件 | 默认值 | 风险 | 说明 |
|---|---|---|---|---|
enabled | toggle | true | risky | 总开关。禁用后 Engram 的行为将停止。 |
scope | select | both | risky | 保存目标:workspace、global、both。 |
update | select | auto | normal | 静默的软件包升级检查:auto、manual、off。 |
read | select | auto | normal | hook 何时注入记忆:auto、startup、always、manual、off。 |
proof | select | off | normal | hook 证明行:off、compact。 |
global_path | text | 空 | risky | 全局记忆的文件系统路径。 |
default_profile | select | 空 | risky | 未显式设置时使用的资料(profile)。 |
roles | roles | 空 | normal | 用于路由的、以逗号分隔的角色名称。 |
Ignore Rules
| 配置键 | 控件 | 默认值 | 风险 | 说明 |
|---|---|---|---|---|
ignore.source | select | engramignore | normal | 扫描规则来源:engramignore、gitignore、both、off。 |
ignore.gitignore_path | text | .gitignore | normal | Git ignore 文件路径。 |
ignore.engramignore_path | text | .engramignore | normal | Engram ignore 文件路径。 |
ignore.global_engramignore | toggle | true | normal | 配置后应用全局忽略规则。 |
ignore.also_ignore | list | *.secret, private/** | normal | 额外的、以逗号分隔的 glob 模式。 |
ignore.global_patterns | textarea | 空 | normal | 每行一个全局 glob;inject 会同步一个受管的工作区块。 |
Load Routing
| 配置键 | 控件 | 默认值 | 风险 | 说明 |
|---|---|---|---|---|
load.limit | number 1–32 | 8 | normal | 正常加载返回的最大记忆数。 |
load.working_ttl_days | number 1–365 | 14 | normal | 任务目标记忆在工作层中保留的天数。 |
Memory Limits
| 配置键 | 控件 | 默认值 | 风险 | 说明 |
|---|---|---|---|---|
memory.rule_line_target | number 50–200, step 10 | 70 | normal | 规则的推荐行数。 |
memory.rule_line_hard_limit | number 50–200, step 10 | 100 | risky | 规则的硬性最大行数。 |
memory.include_author_email | toggle | false | risky | 将 author_email 写入新记忆的 frontmatter(author_name 始终会写入)。 |
Hooks
| 配置键 | 控件 | 默认值 | 风险 | 说明 |
|---|---|---|---|---|
hooks.path_rules | select | native | normal | native:Claude 和 Cursor 从生成的规则文件中加载带有 applies_to 的记忆,且 Claude 注册 InstructionsLoaded。hook:保留 Claude 的 PreToolUse hook 并移除 Claude 的规则文件。 |
Graph
| 配置键 | 控件 | 默认值 | 风险 | 说明 |
|---|---|---|---|---|
graph.enabled | toggle | true | normal | 启用依赖/关系路由。 |
graph.max_related | number 1–20 | 4 | normal | 限制来自图的边的相关记忆数量。 |
graph.min_related_score | number 0–1, step 0.01 | 0.22 | normal | 相关边的最小相似度分数。 |
Vector Search
| 配置键 | 控件 | 默认值 | 风险 | 说明 |
|---|---|---|---|---|
vector.enabled | toggle | false | normal | 实验性:启用可选的本地哈希向量路由(不是语义嵌入)。默认关闭。 |
vector.provider | select | sqlite-vec | normal | 唯一受支持的本地向量提供者。 |
vector.auto_threshold | number 10–1000 | 100 | normal | 向量搜索启用时的记忆数量。 |
vector.candidate_pool | number 8–100 | 24 | normal | 重新排序之前考虑的候选数。 |
vector.dimensions | number 16–512 | 64 | normal | 嵌入维度;更改后需要重建。 |
Rule Variants
| 配置键 | 控件 | 默认值 | 风险 | 说明 |
|---|---|---|---|---|
rule_variants.enabled | toggle | false | normal | 根据每条规则的 Content 渲染 light 和 strict 的措辞(关闭时渲染 balanced)。 |
rule_variants.active | select | balanced | normal | 当前变体:light、balanced、strict。 |
Live Sync
| 配置键 | 控件 | 默认值 | 风险 | 说明 |
|---|---|---|---|---|
live_sync.enabled | toggle | false | normal | 保存时同步生成的 agent 上下文文件。 |
live_sync.targets | list | agents-md, claude-md, cursor-rules | normal | live sync 刷新的生成上下文目标。 |
Global Git
| 配置键 | 控件 | 默认值 | 风险 | 说明 |
|---|---|---|---|---|
global_git.enabled | toggle | true | risky | 为全局记忆启用 Git 行为。 |
global_git.remote | text | origin | risky | Git 远程名称;不含空白字符。 |
global_git.remote_url | text | 空 | risky | 共享的全局记忆远程 URL。 |
global_git.branch | text | main | risky | 同步的目标分支。 |
global_git.auto_sync | toggle | true | risky | 自动 pull/push 行为。 |
global_git.auto_resolve | toggle | true | risky | 自动处理冲突;请审阅 diff。 |
Pattern Mining
| 配置键 | 控件 | 默认值 | 风险 | 说明 |
|---|---|---|---|---|
pattern_mining.enabled | toggle | false | normal | 实验性的重复模式提取。 |
pattern_mining.threshold | number 1–20 | 3 | normal | 模式变得重要所需的重复次数。 |
pattern_mining.lookback_sessions | number 1–100 | 20 | normal | 要检查的近期会话数。 |
PR Workflow
| 配置键 | 控件 | 默认值 | 风险 | 说明 |
|---|---|---|---|---|
pr_workflow.enabled | toggle | false | risky | 实验性的团队 PR 工作流。 |
pr_workflow.provider | text | 空 | risky | 已配置团队工作流的提供者标识符。 |
pr_workflow.repo | text | 空 | risky | 已配置团队工作流的仓库标识符。 |
pr_workflow.target_branch | text | main | risky | 接收记忆 PR 的分支。 |
Encryption
| 配置键 | 控件 | 默认值 | 风险 | 说明 |
|---|---|---|---|---|
encryption.enabled | toggle | false | risky | 未来/高级加密模式。 |
encryption.scope | select | global | risky | 作用域:workspace、global。 |
encryption.key_source | select | portable-file | risky | 密钥来源策略;存在备份丢失风险。 |
证据支持的记忆
| 字段 | 含义 |
|---|---|
schema_version | 新创建或更新的记忆为 3;旧版 v1/v2 仍可读取。 |
authority | 规则/技能为 instruction,知识为 reference。Trace 记录使用 authority: evidence。 |
evidence_refs | 支持该记忆的不可变 tr_... trace ID。 |
derived_from | 该记忆所提炼自的会话或来源标识符。 |
revision | 更新现有记忆时递增的正整数。 |
supersedes / superseded_by | 显式的替换关系。 |
valid_from / valid_until | 记忆有效的时间范围;valid_until 可以是开放式的。 |
last_confirmed | 该记忆最近一次被确认的日期。 |
非配置控件
有关非配置控件,请参阅各标签页的页面:
资料和工作区的管理可在 Construct 标签页中以及通过 engram profile 和 engram workspace 完成。参见资料与作用域解析。
后续步骤
Git 作者身份
Engram 可以存储一个全局作者以及可选的工作区覆盖。解析顺序依次为工作区、全局,然后是只读的 Git 回退。设置仅影响未来的记忆;工作区覆盖绝不会更改全局 Git 配置。全局 Git 同步或旧版记忆迁移需要显式的计划与确认。
engram author show
engram author set --name "Jane Doe" --email "jane@example.com"
engram author unset --scope workspace
engram author sync-git-global --plan
engram author sync-git-global --confirm
engram author migrate-memories --plan
engram author migrate-memories --confirm
请阅读完整的 Git 作者设置指南。
配置升级清单
软件包更新之后,请先运行 engram upgrade --latest --plan,再运行 engram upgrade --latest。共享清单会扫描工作区和全局中由 Engram 管理的记忆、指令、skillset、配置、hook 和插件。用户编写的字节会被保留;含义不明的混合文件会被报告为冲突。参见配置升级。