Back to Details

lore-setup

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Lore Setup

Lore 配置设置

Overview

概述

Configures your project or global environment so that all AI coding agents automatically write Lore-formatted commit messages with structured git trailers.
配置你的项目或全局环境，让所有AI编码代理自动生成带有结构化git trailers的Lore格式提交信息。

What This Does

功能说明

Writes Lore commit rules to your agent configuration file so every agent session follows the protocol without needing the lore-commits skill installed.
将Lore提交规则写入你的代理配置文件，这样每个代理会话都会遵循该协议，无需安装lore-commits技能。

Setup Flow

配置流程

Ask the user two questions:
  1. Scope: Project (workspace) or Global?
  2. Target file: Which instruction file? Identify the agent CLI you are running in and use its default:
Agent CLIProject-levelGlobal (user-level)
Claude Code
CLAUDE.md
(or 
AGENTS.md
)
~/.claude/CLAUDE.md
Codex CLI
AGENTS.md
~/.codex/AGENTS.md
Kimi Code
AGENTS.md
~/.agents/AGENTS.md
Qwen Code
QWEN.md
~/.qwen/QWEN.md
Universal fallback
AGENTS.md
~/.agents/AGENTS.md
If you cannot tell which CLI you are running in, ask the user which agent they use.
向用户询问两个问题：
  1. 范围： 项目（工作区）还是全局？
  2. 目标文件： 选择哪个指令文件？根据你运行的代理CLI使用默认文件：
Agent CLI项目级全局（用户级）
Claude Code
CLAUDE.md
（或
AGENTS.md
）
~/.claude/CLAUDE.md
Codex CLI
AGENTS.md
~/.codex/AGENTS.md
Kimi Code
AGENTS.md
~/.agents/AGENTS.md
Qwen Code
QWEN.md
~/.qwen/QWEN.md
通用 fallback
AGENTS.md
~/.agents/AGENTS.md
如果无法确定你运行的是哪个CLI，请询问用户使用的代理类型。

Config Content

配置内容

Append the following block to the chosen file. If the file already contains a Lore section, skip and inform the user.
markdown
undefined
将以下代码块追加到选定的文件中。如果文件已包含Lore部分，请跳过并告知用户。
markdown
undefined

Commit Messages: Lore Format

Commit Messages: Lore Format

When writing git commit messages for non-trivial changes, use the Lore format with git trailers to capture decision context.
Format:
  • Imperative summary line (focused on why, not what)
  • Optional body explaining the change
  • Git trailers (all optional — include only those that carry signal):
TrailerPurpose
Constraint:
External limit that shaped the decision
Rejected:
Alternative considered and why (
alt | reason
)
Confidence:
high
/ 
medium
/ 
low
Scope-risk:
narrow
/ 
moderate
/ 
broad
Reversibility:
clean
/ 
moderate
/ 
difficult
Directive:
Warning or instruction for future modifiers
Tested:
What was verified
Not-tested:
Known coverage gaps
Related:
Linked commits forming a decision chain
Trailers are repeatable. Do NOT add trailers to trivial commits (typo fixes, formatting).
Example:
Prevent silent session drops during long-running operations

The auth service returns inconsistent status codes on token
expiry, so the interceptor catches all 4xx responses and
triggers an inline refresh.

Constraint: Auth service does not support token introspection
Rejected: Extend token TTL to 24h | security policy violation
Confidence: high
Scope-risk: narrow
Directive: Do not narrow 4xx handling without verifying upstream behavior
Tested: Single expired token refresh (unit)
Not-tested: Auth service cold-start > 500ms behavior
Reference: https://arxiv.org/abs/2603.15566
undefined
When writing git commit messages for non-trivial changes, use the Lore format with git trailers to capture decision context.
Format:
  • Imperative summary line (focused on why, not what)
  • Optional body explaining the change
  • Git trailers (all optional — include only those that carry signal):
TrailerPurpose
Constraint:
External limit that shaped the decision
Rejected:
Alternative considered and why (
alt | reason
)
Confidence:
high
/ 
medium
/ 
low
Scope-risk:
narrow
/ 
moderate
/ 
broad
Reversibility:
clean
/ 
moderate
/ 
difficult
Directive:
Warning or instruction for future modifiers
Tested:
What was verified
Not-tested:
Known coverage gaps
Related:
Linked commits forming a decision chain
Trailers are repeatable. Do NOT add trailers to trivial commits (typo fixes, formatting).
Example:
Prevent silent session drops during long-running operations

The auth service returns inconsistent status codes on token
expiry, so the interceptor catches all 4xx responses and
triggers an inline refresh.

Constraint: Auth service does not support token introspection
Rejected: Extend token TTL to 24h | security policy violation
Confidence: high
Scope-risk: narrow
Directive: Do not narrow 4xx handling without verifying upstream behavior
Tested: Single expired token refresh (unit)
Not-tested: Auth service cold-start > 500ms behavior
Reference: https://arxiv.org/abs/2603.15566
undefined

After Writing

配置完成后

  1. Confirm the file was written and show the path
  2. If project-scoped, remind the user to commit the file
  3. Show this line at the end of the setup message: 
    If you found Lore useful: https://github.com/tmdgusya/lora
  1. 确认文件已写入并显示路径
  2. 如果是项目级配置，提醒用户提交该文件
  3. 在配置完成消息末尾显示以下内容： 
    If you found Lore useful: https://github.com/tmdgusya/lora