Repository files navigation

Ketchup

Turn every AI mistake into a rule AI can't repeat.

Ketchup runs 20+ LLM-powered guardrails on every AI commit, so bad commits don't land.

BuildLicenseTypeScript

/plugin install ketchup

Ketchup is an open-source guardrail engine for Claude Code, from the team at Auto.

Today: Claude Code only. If your agent exposes hooks or an equivalent integration surface, open an issue.


Why

AI coding agents have three problems: they're biased for delivery, they have no negative knowledge about your system, and every prompt is a clean slate that forgets yesterday's lessons. Static tools (eslint, husky, commitlint) can't catch semantic failures: a test that asserts nothing, a commit that bundles three unrelated concerns, a "fix" that rationalizes a shortcut, an architectural rule violated three months after you wrote it.

Ketchup runs a separate Claude subagent against every commit, with your rules as its context and no investment in whether the commit ships. When it finds a violation, it blocks the commit and tells you why.

The workflow is: observe an AI mistake, encode it as a rule, AI can't repeat it. The codebase gets permanently safer as you keep working, not just temporarily cleaner. See Guardrail Engineering for the mechanism and the Ketchup Technique for the planning rhythm that feeds clean work into it.

In the stack

Ketchup comes from the team building Auto, a spec-driven development platform: Auto decides what to build, and Ketchup enforces how. Use them together or use Ketchup on its own; both work.

Key Concepts

  • Hooks: Three integration points (SessionStart, PreToolUse, UserPromptSubmit) that let Ketchup observe and gate Claude Code's behavior
  • Validators: Markdown files with YAML frontmatter that ACK or NACK commits based on your criteria
  • Reminders: Context-injection files that surface your guidelines at the right moment
  • Deny-list: Glob patterns that protect files from modification
  • TCR Discipline: Test && Commit || Revert, so bad code auto-reverts
  • Parallel subagent planning: ketchup-plan.md carries dependency notation so independent bursts launch in parallel sub-agents

Installation

From the Marketplace (recommended)

Inside any Claude Code session:

/plugin marketplace add BeOnAuto/auto-plugins
/plugin install ketchup

As a Local Plugin

claude --plugin-dir /path/to/ketchup

Claude Code sets CLAUDE_PLUGIN_ROOT and CLAUDE_PLUGIN_DATA automatically. Run /ketchup:init inside a session to activate per-project configuration, validators, and logging.

Quick Start

# Marketplace (inside Claude Code)
/plugin marketplace add BeOnAuto/auto-plugins
/plugin install ketchup
# Or local plugin mode
claude --plugin-dir /path/to/ketchup

After installation, Claude will mention that Ketchup is available. To activate it in a project:

/ketchup:init

This creates .ketchup/ with default configuration. You can add it to .gitignore for personal use, or commit it for the whole team.

If you're upgrading from claude-auto, your existing .claude-auto/ directory will be auto-renamed to .ketchup/ on first session-start. No manual action required.

Next steps:


Custom Validators and Reminders

Add project-specific rules by creating markdown files in .ketchup/validators/ and .ketchup/reminders/.

Custom Validator

Create .ketchup/validators/my-rule.md:

---name: my-ruledescription: Enforce my custom ruleenabled: true---
You are validating a git commit. Check that [your criteria here].
Respond with JSON only:
- If the commit passes: {"decision":"ACK"}
- If the commit fails: {"decision":"NACK","reason":"explanation"}

Validators receive the staged diff, file list, and commit message. They must return ACK or NACK as JSON.

Custom Reminder

Create .ketchup/reminders/my-reminder.md:

---when:
hook: UserPromptSubmitpriority: 50---
Your reminder content here. This gets injected on every prompt.

The when field controls when the reminder fires:

ConditionFires when
hook: SessionStartOnce at session start
hook: UserPromptSubmitEvery user prompt
hook: PreToolUseBefore tool execution
hook: PreToolUse + toolName: BashOnly before Bash tool
(no when)All hooks

Higher priority = appears first. Project-local files are loaded alongside plugin defaults. If filenames collide, plugin versions take precedence.

Runtime Configuration

Toggle validators and reminders without editing files:

/ketchup:config show
/ketchup:config validators disable no-comments
/ketchup:config reminders priority my-reminder 200
/ketchup:config reminders add my-rule --hook UserPromptSubmit --priority 50 --content "Always use early returns"

Multiply with Git Worktrees

git worktree add ../feature-auth feature/auth
git worktree add ../feature-payments feature/payments

Each worktree runs its own Ketchup instance, all quality-validated.


Configuration

{
"validateCommit": { "mode": "strict", "batchCount": 3 },
"denyList": { "enabled": true },
"promptReminder": { "enabled": true },
"subagentHooks": {
"validateCommitOnExplore": false,
"validateCommitOnWork": true,
"validateCommitOnUnknown": true
}
}

Configuration lives in .ketchup/state.json. See the Configuration guide for all options.


How It Works

flowchart LR
A[Claude Code] --> B[Hook Scripts]
B --> C{Hook Type}
C -->|SessionStart| D[Load Reminders]
C -->|PreToolUse| E[Validate Commits + Deny-list]
C -->|UserPromptSubmit| F[Inject Reminders]
E -->|ACK| H[Allow]
E -->|NACK| I[Block + Revert]
Loading

Hook scripts read JSON from stdin, delegate to handlers in src/hooks/, log results, and output JSON to stdout. Validators are batched (default 3 per Claude CLI call) for efficient parallel validation. Reminders are matched by hook type, mode, and tool name, then injected as <system-reminder> blocks.


Roadmap

Ketchup is Claude Code-first today. The Ketchup Technique (the methodology) works with any AI coding agent by hand. If your agent exposes hooks or an equivalent integration surface, open an issue so we can scope adapter work.


Troubleshooting

Hooks Not Firing

Symptom: Commits go through without validation.

Cause: Plugin not installed or not enabled.

Solution:

/plugin install ketchup

Enable Debug Logging

DEBUG=ketchup claude --plugin-dir /path/to/ketchup

DEBUG=ketchup writes diagnostics to .ketchup/logs/ketchup/debug.log.


Documentation

GuideDescription
Getting StartedFirst-time setup and core concepts
InstallationDetailed installation guide
The Ketchup TechniqueThe planning methodology
In the StackHow Ketchup fits with Auto and spec-driven development
ConfigurationAll configuration options
Hooks GuideHook system deep-dive
Reminders GuideContext injection system
Validators GuideCommit validation rules
ArchitectureSystem design internals
Origin StoryHow Ketchup came to be

Architecture

.claude-plugin/
└── plugin.json # Plugin manifest (name, version, description)
hooks/
└── hooks.json # Plugin hook definitions (SessionStart, PreToolUse, etc.)
validators/ # Default commit validators
reminders/ # Default context-injection reminders (10 files)
agents/ # Sub-agent definitions (validator agent)
src/
├── brand.ts # BRAND constants (single source of truth for naming)
├── hooks/ # Hook handlers (session-start, pre-tool-use, user-prompt-submit)
├── migrate.ts # .claude-auto -> .ketchup auto-migration
├── path-resolver.ts # Plugin-mode path resolution
├── commit-validator.ts # Batched commit validation with appeal support
├── deny-list.ts # File protection via micromatch patterns
├── reminder-loader.ts # Multi-directory reminder system with deduplication
├── hook-state.ts # Hook state management (state.json)
├── validator-loader.ts # Multi-directory validator loader
└── index.ts # Public API barrel exports
scripts/
├── session-start.ts # SessionStart hook entry-point (runs migration first)
├── pre-tool-use.ts # PreToolUse hook entry-point
└── user-prompt-submit.ts # UserPromptSubmit hook entry-point

Dependencies

PackageUsage
gray-matterYAML frontmatter parsing for validators and reminders
micromatchGlob pattern matching for deny-lists

Development

Prerequisites

  • Node.js 18+
  • pnpm 10+

Setup

git clone https://github.com/BeOnAuto/ketchup.git
cd ketchup
pnpm install
pnpm build

Commands

CommandDescription
pnpm buildTypeScript compile + esbuild bundle scripts
pnpm testRun all tests (vitest)
pnpm type-checkTypeScript type checking
pnpm lintBiome lint check
pnpm checkFull CI: build + type-check + test + lint

License

MIT © 2025 BeOnAuto, Inc.

See LICENSE for details.

About

Turn every AI mistake into a rule AI can't repeat.

Resources

Stars

24 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

Repository files navigation

Ketchup

Turn every AI mistake into a rule AI can't repeat.

Ketchup runs 20+ LLM-powered guardrails on every AI commit, so bad commits don't land.

BuildLicenseTypeScript

/plugin install ketchup

Ketchup is an open-source guardrail engine for Claude Code, from the team at Auto.

Today: Claude Code only. If your agent exposes hooks or an equivalent integration surface, open an issue.


Why

AI coding agents have three problems: they're biased for delivery, they have no negative knowledge about your system, and every prompt is a clean slate that forgets yesterday's lessons. Static tools (eslint, husky, commitlint) can't catch semantic failures: a test that asserts nothing, a commit that bundles three unrelated concerns, a "fix" that rationalizes a shortcut, an architectural rule violated three months after you wrote it.

Ketchup runs a separate Claude subagent against every commit, with your rules as its context and no investment in whether the commit ships. When it finds a violation, it blocks the commit and tells you why.

The workflow is: observe an AI mistake, encode it as a rule, AI can't repeat it. The codebase gets permanently safer as you keep working, not just temporarily cleaner. See Guardrail Engineering for the mechanism and the Ketchup Technique for the planning rhythm that feeds clean work into it.

In the stack

Ketchup comes from the team building Auto, a spec-driven development platform: Auto decides what to build, and Ketchup enforces how. Use them together or use Ketchup on its own; both work.

Key Concepts

  • Hooks: Three integration points (SessionStart, PreToolUse, UserPromptSubmit) that let Ketchup observe and gate Claude Code's behavior
  • Validators: Markdown files with YAML frontmatter that ACK or NACK commits based on your criteria
  • Reminders: Context-injection files that surface your guidelines at the right moment
  • Deny-list: Glob patterns that protect files from modification
  • TCR Discipline: Test && Commit || Revert, so bad code auto-reverts
  • Parallel subagent planning: ketchup-plan.md carries dependency notation so independent bursts launch in parallel sub-agents

Installation

From the Marketplace (recommended)

Inside any Claude Code session:

/plugin marketplace add BeOnAuto/auto-plugins
/plugin install ketchup

As a Local Plugin

claude --plugin-dir /path/to/ketchup

Claude Code sets CLAUDE_PLUGIN_ROOT and CLAUDE_PLUGIN_DATA automatically. Run /ketchup:init inside a session to activate per-project configuration, validators, and logging.

Quick Start

# Marketplace (inside Claude Code)
/plugin marketplace add BeOnAuto/auto-plugins
/plugin install ketchup
# Or local plugin mode
claude --plugin-dir /path/to/ketchup

After installation, Claude will mention that Ketchup is available. To activate it in a project:

/ketchup:init

This creates .ketchup/ with default configuration. You can add it to .gitignore for personal use, or commit it for the whole team.

If you're upgrading from claude-auto, your existing .claude-auto/ directory will be auto-renamed to .ketchup/ on first session-start. No manual action required.

Next steps:


Custom Validators and Reminders

Add project-specific rules by creating markdown files in .ketchup/validators/ and .ketchup/reminders/.

Custom Validator

Create .ketchup/validators/my-rule.md:

---name: my-ruledescription: Enforce my custom ruleenabled: true---
You are validating a git commit. Check that [your criteria here].
Respond with JSON only:
- If the commit passes: {"decision":"ACK"}
- If the commit fails: {"decision":"NACK","reason":"explanation"}

Validators receive the staged diff, file list, and commit message. They must return ACK or NACK as JSON.

Custom Reminder

Create .ketchup/reminders/my-reminder.md:

---when:
hook: UserPromptSubmitpriority: 50---
Your reminder content here. This gets injected on every prompt.

The when field controls when the reminder fires:

ConditionFires when
hook: SessionStartOnce at session start
hook: UserPromptSubmitEvery user prompt
hook: PreToolUseBefore tool execution
hook: PreToolUse + toolName: BashOnly before Bash tool
(no when)All hooks

Higher priority = appears first. Project-local files are loaded alongside plugin defaults. If filenames collide, plugin versions take precedence.

Runtime Configuration

Toggle validators and reminders without editing files:

/ketchup:config show
/ketchup:config validators disable no-comments
/ketchup:config reminders priority my-reminder 200
/ketchup:config reminders add my-rule --hook UserPromptSubmit --priority 50 --content "Always use early returns"

Multiply with Git Worktrees

git worktree add ../feature-auth feature/auth
git worktree add ../feature-payments feature/payments

Each worktree runs its own Ketchup instance, all quality-validated.


Configuration

{
"validateCommit": { "mode": "strict", "batchCount": 3 },
"denyList": { "enabled": true },
"promptReminder": { "enabled": true },
"subagentHooks": {
"validateCommitOnExplore": false,
"validateCommitOnWork": true,
"validateCommitOnUnknown": true
}
}

Configuration lives in .ketchup/state.json. See the Configuration guide for all options.


How It Works

flowchart LR
A[Claude Code] --> B[Hook Scripts]
B --> C{Hook Type}
C -->|SessionStart| D[Load Reminders]
C -->|PreToolUse| E[Validate Commits + Deny-list]
C -->|UserPromptSubmit| F[Inject Reminders]
E -->|ACK| H[Allow]
E -->|NACK| I[Block + Revert]
Loading

Hook scripts read JSON from stdin, delegate to handlers in src/hooks/, log results, and output JSON to stdout. Validators are batched (default 3 per Claude CLI call) for efficient parallel validation. Reminders are matched by hook type, mode, and tool name, then injected as <system-reminder> blocks.


Roadmap

Ketchup is Claude Code-first today. The Ketchup Technique (the methodology) works with any AI coding agent by hand. If your agent exposes hooks or an equivalent integration surface, open an issue so we can scope adapter work.


Troubleshooting

Hooks Not Firing

Symptom: Commits go through without validation.

Cause: Plugin not installed or not enabled.

Solution:

/plugin install ketchup

Enable Debug Logging

DEBUG=ketchup claude --plugin-dir /path/to/ketchup

DEBUG=ketchup writes diagnostics to .ketchup/logs/ketchup/debug.log.


Documentation

GuideDescription
Getting StartedFirst-time setup and core concepts
InstallationDetailed installation guide
The Ketchup TechniqueThe planning methodology
In the StackHow Ketchup fits with Auto and spec-driven development
ConfigurationAll configuration options
Hooks GuideHook system deep-dive
Reminders GuideContext injection system
Validators GuideCommit validation rules
ArchitectureSystem design internals
Origin StoryHow Ketchup came to be

Architecture

.claude-plugin/
└── plugin.json # Plugin manifest (name, version, description)
hooks/
└── hooks.json # Plugin hook definitions (SessionStart, PreToolUse, etc.)
validators/ # Default commit validators
reminders/ # Default context-injection reminders (10 files)
agents/ # Sub-agent definitions (validator agent)
src/
├── brand.ts # BRAND constants (single source of truth for naming)
├── hooks/ # Hook handlers (session-start, pre-tool-use, user-prompt-submit)
├── migrate.ts # .claude-auto -> .ketchup auto-migration
├── path-resolver.ts # Plugin-mode path resolution
├── commit-validator.ts # Batched commit validation with appeal support
├── deny-list.ts # File protection via micromatch patterns
├── reminder-loader.ts # Multi-directory reminder system with deduplication
├── hook-state.ts # Hook state management (state.json)
├── validator-loader.ts # Multi-directory validator loader
└── index.ts # Public API barrel exports
scripts/
├── session-start.ts # SessionStart hook entry-point (runs migration first)
├── pre-tool-use.ts # PreToolUse hook entry-point
└── user-prompt-submit.ts # UserPromptSubmit hook entry-point

Dependencies

PackageUsage
gray-matterYAML frontmatter parsing for validators and reminders
micromatchGlob pattern matching for deny-lists

Development

Prerequisites

  • Node.js 18+
  • pnpm 10+

Setup

git clone https://github.com/BeOnAuto/ketchup.git
cd ketchup
pnpm install
pnpm build

Commands

CommandDescription
pnpm buildTypeScript compile + esbuild bundle scripts
pnpm testRun all tests (vitest)
pnpm type-checkTypeScript type checking
pnpm lintBiome lint check
pnpm checkFull CI: build + type-check + test + lint

License

MIT © 2025 BeOnAuto, Inc.

See LICENSE for details.

About

Turn every AI mistake into a rule AI can't repeat.

Resources

Stars

24 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation

Ketchup

Turn every AI mistake into a rule AI can't repeat.

Ketchup runs 20+ LLM-powered guardrails on every AI commit, so bad commits don't land.

BuildLicenseTypeScript

/plugin install ketchup

Ketchup is an open-source guardrail engine for Claude Code, from the team at Auto.

Today: Claude Code only. If your agent exposes hooks or an equivalent integration surface, open an issue.


Why

AI coding agents have three problems: they're biased for delivery, they have no negative knowledge about your system, and every prompt is a clean slate that forgets yesterday's lessons. Static tools (eslint, husky, commitlint) can't catch semantic failures: a test that asserts nothing, a commit that bundles three unrelated concerns, a "fix" that rationalizes a shortcut, an architectural rule violated three months after you wrote it.

Ketchup runs a separate Claude subagent against every commit, with your rules as its context and no investment in whether the commit ships. When it finds a violation, it blocks the commit and tells you why.

The workflow is: observe an AI mistake, encode it as a rule, AI can't repeat it. The codebase gets permanently safer as you keep working, not just temporarily cleaner. See Guardrail Engineering for the mechanism and the Ketchup Technique for the planning rhythm that feeds clean work into it.

In the stack

Ketchup comes from the team building Auto, a spec-driven development platform: Auto decides what to build, and Ketchup enforces how. Use them together or use Ketchup on its own; both work.

Key Concepts

  • Hooks: Three integration points (SessionStart, PreToolUse, UserPromptSubmit) that let Ketchup observe and gate Claude Code's behavior
  • Validators: Markdown files with YAML frontmatter that ACK or NACK commits based on your criteria
  • Reminders: Context-injection files that surface your guidelines at the right moment
  • Deny-list: Glob patterns that protect files from modification
  • TCR Discipline: Test && Commit || Revert, so bad code auto-reverts
  • Parallel subagent planning: ketchup-plan.md carries dependency notation so independent bursts launch in parallel sub-agents

Installation

From the Marketplace (recommended)

Inside any Claude Code session:

/plugin marketplace add BeOnAuto/auto-plugins
/plugin install ketchup

As a Local Plugin

claude --plugin-dir /path/to/ketchup

Claude Code sets CLAUDE_PLUGIN_ROOT and CLAUDE_PLUGIN_DATA automatically. Run /ketchup:init inside a session to activate per-project configuration, validators, and logging.

Quick Start

# Marketplace (inside Claude Code)
/plugin marketplace add BeOnAuto/auto-plugins
/plugin install ketchup
# Or local plugin mode
claude --plugin-dir /path/to/ketchup

After installation, Claude will mention that Ketchup is available. To activate it in a project:

/ketchup:init

This creates .ketchup/ with default configuration. You can add it to .gitignore for personal use, or commit it for the whole team.

If you're upgrading from claude-auto, your existing .claude-auto/ directory will be auto-renamed to .ketchup/ on first session-start. No manual action required.

Next steps:


Custom Validators and Reminders

Add project-specific rules by creating markdown files in .ketchup/validators/ and .ketchup/reminders/.

Custom Validator

Create .ketchup/validators/my-rule.md:

---name: my-ruledescription: Enforce my custom ruleenabled: true---
You are validating a git commit. Check that [your criteria here].
Respond with JSON only:
- If the commit passes: {"decision":"ACK"}
- If the commit fails: {"decision":"NACK","reason":"explanation"}

Validators receive the staged diff, file list, and commit message. They must return ACK or NACK as JSON.

Custom Reminder

Create .ketchup/reminders/my-reminder.md:

---when:
hook: UserPromptSubmitpriority: 50---
Your reminder content here. This gets injected on every prompt.

The when field controls when the reminder fires:

ConditionFires when
hook: SessionStartOnce at session start
hook: UserPromptSubmitEvery user prompt
hook: PreToolUseBefore tool execution
hook: PreToolUse + toolName: BashOnly before Bash tool
(no when)All hooks

Higher priority = appears first. Project-local files are loaded alongside plugin defaults. If filenames collide, plugin versions take precedence.

Runtime Configuration

Toggle validators and reminders without editing files:

/ketchup:config show
/ketchup:config validators disable no-comments
/ketchup:config reminders priority my-reminder 200
/ketchup:config reminders add my-rule --hook UserPromptSubmit --priority 50 --content "Always use early returns"

Multiply with Git Worktrees

git worktree add ../feature-auth feature/auth
git worktree add ../feature-payments feature/payments

Each worktree runs its own Ketchup instance, all quality-validated.


Configuration

{
"validateCommit": { "mode": "strict", "batchCount": 3 },
"denyList": { "enabled": true },
"promptReminder": { "enabled": true },
"subagentHooks": {
"validateCommitOnExplore": false,
"validateCommitOnWork": true,
"validateCommitOnUnknown": true
}
}

Configuration lives in .ketchup/state.json. See the Configuration guide for all options.


How It Works

flowchart LR
A[Claude Code] --> B[Hook Scripts]
B --> C{Hook Type}
C -->|SessionStart| D[Load Reminders]
C -->|PreToolUse| E[Validate Commits + Deny-list]
C -->|UserPromptSubmit| F[Inject Reminders]
E -->|ACK| H[Allow]
E -->|NACK| I[Block + Revert]
Loading

Hook scripts read JSON from stdin, delegate to handlers in src/hooks/, log results, and output JSON to stdout. Validators are batched (default 3 per Claude CLI call) for efficient parallel validation. Reminders are matched by hook type, mode, and tool name, then injected as <system-reminder> blocks.


Roadmap

Ketchup is Claude Code-first today. The Ketchup Technique (the methodology) works with any AI coding agent by hand. If your agent exposes hooks or an equivalent integration surface, open an issue so we can scope adapter work.


Troubleshooting

Hooks Not Firing

Symptom: Commits go through without validation.

Cause: Plugin not installed or not enabled.

Solution:

/plugin install ketchup

Enable Debug Logging

DEBUG=ketchup claude --plugin-dir /path/to/ketchup

DEBUG=ketchup writes diagnostics to .ketchup/logs/ketchup/debug.log.


Documentation

GuideDescription
Getting StartedFirst-time setup and core concepts
InstallationDetailed installation guide
The Ketchup TechniqueThe planning methodology
In the StackHow Ketchup fits with Auto and spec-driven development
ConfigurationAll configuration options
Hooks GuideHook system deep-dive
Reminders GuideContext injection system
Validators GuideCommit validation rules
ArchitectureSystem design internals
Origin StoryHow Ketchup came to be

Architecture

.claude-plugin/
└── plugin.json # Plugin manifest (name, version, description)
hooks/
└── hooks.json # Plugin hook definitions (SessionStart, PreToolUse, etc.)
validators/ # Default commit validators
reminders/ # Default context-injection reminders (10 files)
agents/ # Sub-agent definitions (validator agent)
src/
├── brand.ts # BRAND constants (single source of truth for naming)
├── hooks/ # Hook handlers (session-start, pre-tool-use, user-prompt-submit)
├── migrate.ts # .claude-auto -> .ketchup auto-migration
├── path-resolver.ts # Plugin-mode path resolution
├── commit-validator.ts # Batched commit validation with appeal support
├── deny-list.ts # File protection via micromatch patterns
├── reminder-loader.ts # Multi-directory reminder system with deduplication
├── hook-state.ts # Hook state management (state.json)
├── validator-loader.ts # Multi-directory validator loader
└── index.ts # Public API barrel exports
scripts/
├── session-start.ts # SessionStart hook entry-point (runs migration first)
├── pre-tool-use.ts # PreToolUse hook entry-point
└── user-prompt-submit.ts # UserPromptSubmit hook entry-point

Dependencies

PackageUsage
gray-matterYAML frontmatter parsing for validators and reminders
micromatchGlob pattern matching for deny-lists

Development

Prerequisites

  • Node.js 18+
  • pnpm 10+

Setup

git clone https://github.com/BeOnAuto/ketchup.git
cd ketchup
pnpm install
pnpm build

Commands

CommandDescription
pnpm buildTypeScript compile + esbuild bundle scripts
pnpm testRun all tests (vitest)
pnpm type-checkTypeScript type checking
pnpm lintBiome lint check
pnpm checkFull CI: build + type-check + test + lint

License

MIT © 2025 BeOnAuto, Inc.

See LICENSE for details.

About

Turn every AI mistake into a rule AI can't repeat.

Resources

Stars

24 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation

Ketchup

Turn every AI mistake into a rule AI can't repeat.

Ketchup runs 20+ LLM-powered guardrails on every AI commit, so bad commits don't land.

BuildLicenseTypeScript

/plugin install ketchup

Ketchup is an open-source guardrail engine for Claude Code, from the team at Auto.

Today: Claude Code only. If your agent exposes hooks or an equivalent integration surface, open an issue.


Why

AI coding agents have three problems: they're biased for delivery, they have no negative knowledge about your system, and every prompt is a clean slate that forgets yesterday's lessons. Static tools (eslint, husky, commitlint) can't catch semantic failures: a test that asserts nothing, a commit that bundles three unrelated concerns, a "fix" that rationalizes a shortcut, an architectural rule violated three months after you wrote it.

Ketchup runs a separate Claude subagent against every commit, with your rules as its context and no investment in whether the commit ships. When it finds a violation, it blocks the commit and tells you why.

The workflow is: observe an AI mistake, encode it as a rule, AI can't repeat it. The codebase gets permanently safer as you keep working, not just temporarily cleaner. See Guardrail Engineering for the mechanism and the Ketchup Technique for the planning rhythm that feeds clean work into it.

In the stack

Ketchup comes from the team building Auto, a spec-driven development platform: Auto decides what to build, and Ketchup enforces how. Use them together or use Ketchup on its own; both work.

Key Concepts

  • Hooks: Three integration points (SessionStart, PreToolUse, UserPromptSubmit) that let Ketchup observe and gate Claude Code's behavior
  • Validators: Markdown files with YAML frontmatter that ACK or NACK commits based on your criteria
  • Reminders: Context-injection files that surface your guidelines at the right moment
  • Deny-list: Glob patterns that protect files from modification
  • TCR Discipline: Test && Commit || Revert, so bad code auto-reverts
  • Parallel subagent planning: ketchup-plan.md carries dependency notation so independent bursts launch in parallel sub-agents

Installation

From the Marketplace (recommended)

Inside any Claude Code session:

/plugin marketplace add BeOnAuto/auto-plugins
/plugin install ketchup

As a Local Plugin

claude --plugin-dir /path/to/ketchup

Claude Code sets CLAUDE_PLUGIN_ROOT and CLAUDE_PLUGIN_DATA automatically. Run /ketchup:init inside a session to activate per-project configuration, validators, and logging.

Quick Start

# Marketplace (inside Claude Code)
/plugin marketplace add BeOnAuto/auto-plugins
/plugin install ketchup
# Or local plugin mode
claude --plugin-dir /path/to/ketchup

After installation, Claude will mention that Ketchup is available. To activate it in a project:

/ketchup:init

This creates .ketchup/ with default configuration. You can add it to .gitignore for personal use, or commit it for the whole team.

If you're upgrading from claude-auto, your existing .claude-auto/ directory will be auto-renamed to .ketchup/ on first session-start. No manual action required.

Next steps:


Custom Validators and Reminders

Add project-specific rules by creating markdown files in .ketchup/validators/ and .ketchup/reminders/.

Custom Validator

Create .ketchup/validators/my-rule.md:

---name: my-ruledescription: Enforce my custom ruleenabled: true---
You are validating a git commit. Check that [your criteria here].
Respond with JSON only:
- If the commit passes: {"decision":"ACK"}
- If the commit fails: {"decision":"NACK","reason":"explanation"}

Validators receive the staged diff, file list, and commit message. They must return ACK or NACK as JSON.

Custom Reminder

Create .ketchup/reminders/my-reminder.md:

---when:
hook: UserPromptSubmitpriority: 50---
Your reminder content here. This gets injected on every prompt.

The when field controls when the reminder fires:

ConditionFires when
hook: SessionStartOnce at session start
hook: UserPromptSubmitEvery user prompt
hook: PreToolUseBefore tool execution
hook: PreToolUse + toolName: BashOnly before Bash tool
(no when)All hooks

Higher priority = appears first. Project-local files are loaded alongside plugin defaults. If filenames collide, plugin versions take precedence.

Runtime Configuration

Toggle validators and reminders without editing files:

/ketchup:config show
/ketchup:config validators disable no-comments
/ketchup:config reminders priority my-reminder 200
/ketchup:config reminders add my-rule --hook UserPromptSubmit --priority 50 --content "Always use early returns"

Multiply with Git Worktrees

git worktree add ../feature-auth feature/auth
git worktree add ../feature-payments feature/payments

Each worktree runs its own Ketchup instance, all quality-validated.


Configuration

{
"validateCommit": { "mode": "strict", "batchCount": 3 },
"denyList": { "enabled": true },
"promptReminder": { "enabled": true },
"subagentHooks": {
"validateCommitOnExplore": false,
"validateCommitOnWork": true,
"validateCommitOnUnknown": true
}
}

Configuration lives in .ketchup/state.json. See the Configuration guide for all options.


How It Works

flowchart LR
A[Claude Code] --> B[Hook Scripts]
B --> C{Hook Type}
C -->|SessionStart| D[Load Reminders]
C -->|PreToolUse| E[Validate Commits + Deny-list]
C -->|UserPromptSubmit| F[Inject Reminders]
E -->|ACK| H[Allow]
E -->|NACK| I[Block + Revert]
Loading

Hook scripts read JSON from stdin, delegate to handlers in src/hooks/, log results, and output JSON to stdout. Validators are batched (default 3 per Claude CLI call) for efficient parallel validation. Reminders are matched by hook type, mode, and tool name, then injected as <system-reminder> blocks.


Roadmap

Ketchup is Claude Code-first today. The Ketchup Technique (the methodology) works with any AI coding agent by hand. If your agent exposes hooks or an equivalent integration surface, open an issue so we can scope adapter work.


Troubleshooting

Hooks Not Firing

Symptom: Commits go through without validation.

Cause: Plugin not installed or not enabled.

Solution:

/plugin install ketchup

Enable Debug Logging

DEBUG=ketchup claude --plugin-dir /path/to/ketchup

DEBUG=ketchup writes diagnostics to .ketchup/logs/ketchup/debug.log.


Documentation

GuideDescription
Getting StartedFirst-time setup and core concepts
InstallationDetailed installation guide
The Ketchup TechniqueThe planning methodology
In the StackHow Ketchup fits with Auto and spec-driven development
ConfigurationAll configuration options
Hooks GuideHook system deep-dive
Reminders GuideContext injection system
Validators GuideCommit validation rules
ArchitectureSystem design internals
Origin StoryHow Ketchup came to be

Architecture

.claude-plugin/
└── plugin.json # Plugin manifest (name, version, description)
hooks/
└── hooks.json # Plugin hook definitions (SessionStart, PreToolUse, etc.)
validators/ # Default commit validators
reminders/ # Default context-injection reminders (10 files)
agents/ # Sub-agent definitions (validator agent)
src/
├── brand.ts # BRAND constants (single source of truth for naming)
├── hooks/ # Hook handlers (session-start, pre-tool-use, user-prompt-submit)
├── migrate.ts # .claude-auto -> .ketchup auto-migration
├── path-resolver.ts # Plugin-mode path resolution
├── commit-validator.ts # Batched commit validation with appeal support
├── deny-list.ts # File protection via micromatch patterns
├── reminder-loader.ts # Multi-directory reminder system with deduplication
├── hook-state.ts # Hook state management (state.json)
├── validator-loader.ts # Multi-directory validator loader
└── index.ts # Public API barrel exports
scripts/
├── session-start.ts # SessionStart hook entry-point (runs migration first)
├── pre-tool-use.ts # PreToolUse hook entry-point
└── user-prompt-submit.ts # UserPromptSubmit hook entry-point

Dependencies

PackageUsage
gray-matterYAML frontmatter parsing for validators and reminders
micromatchGlob pattern matching for deny-lists

Development

Prerequisites

  • Node.js 18+
  • pnpm 10+

Setup

git clone https://github.com/BeOnAuto/ketchup.git
cd ketchup
pnpm install
pnpm build

Commands

CommandDescription
pnpm buildTypeScript compile + esbuild bundle scripts
pnpm testRun all tests (vitest)
pnpm type-checkTypeScript type checking
pnpm lintBiome lint check
pnpm checkFull CI: build + type-check + test + lint

License

MIT © 2025 BeOnAuto, Inc.

See LICENSE for details.

About

Turn every AI mistake into a rule AI can't repeat.

Resources

Stars

24 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

Repository files navigation

Ketchup

Turn every AI mistake into a rule AI can't repeat.

Ketchup runs 20+ LLM-powered guardrails on every AI commit, so bad commits don't land.

BuildLicenseTypeScript

/plugin install ketchup

Ketchup is an open-source guardrail engine for Claude Code, from the team at Auto.

Today: Claude Code only. If your agent exposes hooks or an equivalent integration surface, open an issue.


Why

AI coding agents have three problems: they're biased for delivery, they have no negative knowledge about your system, and every prompt is a clean slate that forgets yesterday's lessons. Static tools (eslint, husky, commitlint) can't catch semantic failures: a test that asserts nothing, a commit that bundles three unrelated concerns, a "fix" that rationalizes a shortcut, an architectural rule violated three months after you wrote it.

Ketchup runs a separate Claude subagent against every commit, with your rules as its context and no investment in whether the commit ships. When it finds a violation, it blocks the commit and tells you why.

The workflow is: observe an AI mistake, encode it as a rule, AI can't repeat it. The codebase gets permanently safer as you keep working, not just temporarily cleaner. See Guardrail Engineering for the mechanism and the Ketchup Technique for the planning rhythm that feeds clean work into it.

In the stack

Ketchup comes from the team building Auto, a spec-driven development platform: Auto decides what to build, and Ketchup enforces how. Use them together or use Ketchup on its own; both work.

Key Concepts

  • Hooks: Three integration points (SessionStart, PreToolUse, UserPromptSubmit) that let Ketchup observe and gate Claude Code's behavior
  • Validators: Markdown files with YAML frontmatter that ACK or NACK commits based on your criteria
  • Reminders: Context-injection files that surface your guidelines at the right moment
  • Deny-list: Glob patterns that protect files from modification
  • TCR Discipline: Test && Commit || Revert, so bad code auto-reverts
  • Parallel subagent planning: ketchup-plan.md carries dependency notation so independent bursts launch in parallel sub-agents

Installation

From the Marketplace (recommended)

Inside any Claude Code session:

/plugin marketplace add BeOnAuto/auto-plugins
/plugin install ketchup

As a Local Plugin

claude --plugin-dir /path/to/ketchup

Claude Code sets CLAUDE_PLUGIN_ROOT and CLAUDE_PLUGIN_DATA automatically. Run /ketchup:init inside a session to activate per-project configuration, validators, and logging.

Quick Start

# Marketplace (inside Claude Code)
/plugin marketplace add BeOnAuto/auto-plugins
/plugin install ketchup
# Or local plugin mode
claude --plugin-dir /path/to/ketchup

After installation, Claude will mention that Ketchup is available. To activate it in a project:

/ketchup:init

This creates .ketchup/ with default configuration. You can add it to .gitignore for personal use, or commit it for the whole team.

If you're upgrading from claude-auto, your existing .claude-auto/ directory will be auto-renamed to .ketchup/ on first session-start. No manual action required.

Next steps:


Custom Validators and Reminders

Add project-specific rules by creating markdown files in .ketchup/validators/ and .ketchup/reminders/.

Custom Validator

Create .ketchup/validators/my-rule.md:

---name: my-ruledescription: Enforce my custom ruleenabled: true---
You are validating a git commit. Check that [your criteria here].
Respond with JSON only:
- If the commit passes: {"decision":"ACK"}
- If the commit fails: {"decision":"NACK","reason":"explanation"}

Validators receive the staged diff, file list, and commit message. They must return ACK or NACK as JSON.

Custom Reminder

Create .ketchup/reminders/my-reminder.md:

---when:
hook: UserPromptSubmitpriority: 50---
Your reminder content here. This gets injected on every prompt.

The when field controls when the reminder fires:

ConditionFires when
hook: SessionStartOnce at session start
hook: UserPromptSubmitEvery user prompt
hook: PreToolUseBefore tool execution
hook: PreToolUse + toolName: BashOnly before Bash tool
(no when)All hooks

Higher priority = appears first. Project-local files are loaded alongside plugin defaults. If filenames collide, plugin versions take precedence.

Runtime Configuration

Toggle validators and reminders without editing files:

/ketchup:config show
/ketchup:config validators disable no-comments
/ketchup:config reminders priority my-reminder 200
/ketchup:config reminders add my-rule --hook UserPromptSubmit --priority 50 --content "Always use early returns"

Multiply with Git Worktrees

git worktree add ../feature-auth feature/auth
git worktree add ../feature-payments feature/payments

Each worktree runs its own Ketchup instance, all quality-validated.


Configuration

{
"validateCommit": { "mode": "strict", "batchCount": 3 },
"denyList": { "enabled": true },
"promptReminder": { "enabled": true },
"subagentHooks": {
"validateCommitOnExplore": false,
"validateCommitOnWork": true,
"validateCommitOnUnknown": true
}
}

Configuration lives in .ketchup/state.json. See the Configuration guide for all options.


How It Works

flowchart LR
A[Claude Code] --> B[Hook Scripts]
B --> C{Hook Type}
C -->|SessionStart| D[Load Reminders]
C -->|PreToolUse| E[Validate Commits + Deny-list]
C -->|UserPromptSubmit| F[Inject Reminders]
E -->|ACK| H[Allow]
E -->|NACK| I[Block + Revert]
Loading

Hook scripts read JSON from stdin, delegate to handlers in src/hooks/, log results, and output JSON to stdout. Validators are batched (default 3 per Claude CLI call) for efficient parallel validation. Reminders are matched by hook type, mode, and tool name, then injected as <system-reminder> blocks.


Roadmap

Ketchup is Claude Code-first today. The Ketchup Technique (the methodology) works with any AI coding agent by hand. If your agent exposes hooks or an equivalent integration surface, open an issue so we can scope adapter work.


Troubleshooting

Hooks Not Firing

Symptom: Commits go through without validation.

Cause: Plugin not installed or not enabled.

Solution:

/plugin install ketchup

Enable Debug Logging

DEBUG=ketchup claude --plugin-dir /path/to/ketchup

DEBUG=ketchup writes diagnostics to .ketchup/logs/ketchup/debug.log.


Documentation

GuideDescription
Getting StartedFirst-time setup and core concepts
InstallationDetailed installation guide
The Ketchup TechniqueThe planning methodology
In the StackHow Ketchup fits with Auto and spec-driven development
ConfigurationAll configuration options
Hooks GuideHook system deep-dive
Reminders GuideContext injection system
Validators GuideCommit validation rules
ArchitectureSystem design internals
Origin StoryHow Ketchup came to be

Architecture

.claude-plugin/
└── plugin.json # Plugin manifest (name, version, description)
hooks/
└── hooks.json # Plugin hook definitions (SessionStart, PreToolUse, etc.)
validators/ # Default commit validators
reminders/ # Default context-injection reminders (10 files)
agents/ # Sub-agent definitions (validator agent)
src/
├── brand.ts # BRAND constants (single source of truth for naming)
├── hooks/ # Hook handlers (session-start, pre-tool-use, user-prompt-submit)
├── migrate.ts # .claude-auto -> .ketchup auto-migration
├── path-resolver.ts # Plugin-mode path resolution
├── commit-validator.ts # Batched commit validation with appeal support
├── deny-list.ts # File protection via micromatch patterns
├── reminder-loader.ts # Multi-directory reminder system with deduplication
├── hook-state.ts # Hook state management (state.json)
├── validator-loader.ts # Multi-directory validator loader
└── index.ts # Public API barrel exports
scripts/
├── session-start.ts # SessionStart hook entry-point (runs migration first)
├── pre-tool-use.ts # PreToolUse hook entry-point
└── user-prompt-submit.ts # UserPromptSubmit hook entry-point

Dependencies

PackageUsage
gray-matterYAML frontmatter parsing for validators and reminders
micromatchGlob pattern matching for deny-lists

Development

Prerequisites

  • Node.js 18+
  • pnpm 10+

Setup

git clone https://github.com/BeOnAuto/ketchup.git
cd ketchup
pnpm install
pnpm build

Commands

CommandDescription
pnpm buildTypeScript compile + esbuild bundle scripts
pnpm testRun all tests (vitest)
pnpm type-checkTypeScript type checking
pnpm lintBiome lint check
pnpm checkFull CI: build + type-check + test + lint

License

MIT © 2025 BeOnAuto, Inc.

See LICENSE for details.

About

Turn every AI mistake into a rule AI can't repeat.

Resources

Stars

24 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation

Ketchup

Turn every AI mistake into a rule AI can't repeat.

Ketchup runs 20+ LLM-powered guardrails on every AI commit, so bad commits don't land.

BuildLicenseTypeScript

/plugin install ketchup

Ketchup is an open-source guardrail engine for Claude Code, from the team at Auto.

Today: Claude Code only. If your agent exposes hooks or an equivalent integration surface, open an issue.


Why

AI coding agents have three problems: they're biased for delivery, they have no negative knowledge about your system, and every prompt is a clean slate that forgets yesterday's lessons. Static tools (eslint, husky, commitlint) can't catch semantic failures: a test that asserts nothing, a commit that bundles three unrelated concerns, a "fix" that rationalizes a shortcut, an architectural rule violated three months after you wrote it.

Ketchup runs a separate Claude subagent against every commit, with your rules as its context and no investment in whether the commit ships. When it finds a violation, it blocks the commit and tells you why.

The workflow is: observe an AI mistake, encode it as a rule, AI can't repeat it. The codebase gets permanently safer as you keep working, not just temporarily cleaner. See Guardrail Engineering for the mechanism and the Ketchup Technique for the planning rhythm that feeds clean work into it.

In the stack

Ketchup comes from the team building Auto, a spec-driven development platform: Auto decides what to build, and Ketchup enforces how. Use them together or use Ketchup on its own; both work.

Key Concepts

  • Hooks: Three integration points (SessionStart, PreToolUse, UserPromptSubmit) that let Ketchup observe and gate Claude Code's behavior
  • Validators: Markdown files with YAML frontmatter that ACK or NACK commits based on your criteria
  • Reminders: Context-injection files that surface your guidelines at the right moment
  • Deny-list: Glob patterns that protect files from modification
  • TCR Discipline: Test && Commit || Revert, so bad code auto-reverts
  • Parallel subagent planning: ketchup-plan.md carries dependency notation so independent bursts launch in parallel sub-agents

Installation

From the Marketplace (recommended)

Inside any Claude Code session:

/plugin marketplace add BeOnAuto/auto-plugins
/plugin install ketchup

As a Local Plugin

claude --plugin-dir /path/to/ketchup

Claude Code sets CLAUDE_PLUGIN_ROOT and CLAUDE_PLUGIN_DATA automatically. Run /ketchup:init inside a session to activate per-project configuration, validators, and logging.

Quick Start

# Marketplace (inside Claude Code)
/plugin marketplace add BeOnAuto/auto-plugins
/plugin install ketchup
# Or local plugin mode
claude --plugin-dir /path/to/ketchup

After installation, Claude will mention that Ketchup is available. To activate it in a project:

/ketchup:init

This creates .ketchup/ with default configuration. You can add it to .gitignore for personal use, or commit it for the whole team.

If you're upgrading from claude-auto, your existing .claude-auto/ directory will be auto-renamed to .ketchup/ on first session-start. No manual action required.

Next steps:


Custom Validators and Reminders

Add project-specific rules by creating markdown files in .ketchup/validators/ and .ketchup/reminders/.

Custom Validator

Create .ketchup/validators/my-rule.md:

---name: my-ruledescription: Enforce my custom ruleenabled: true---
You are validating a git commit. Check that [your criteria here].
Respond with JSON only:
- If the commit passes: {"decision":"ACK"}
- If the commit fails: {"decision":"NACK","reason":"explanation"}

Validators receive the staged diff, file list, and commit message. They must return ACK or NACK as JSON.

Custom Reminder

Create .ketchup/reminders/my-reminder.md:

---when:
hook: UserPromptSubmitpriority: 50---
Your reminder content here. This gets injected on every prompt.

The when field controls when the reminder fires:

ConditionFires when
hook: SessionStartOnce at session start
hook: UserPromptSubmitEvery user prompt
hook: PreToolUseBefore tool execution
hook: PreToolUse + toolName: BashOnly before Bash tool
(no when)All hooks

Higher priority = appears first. Project-local files are loaded alongside plugin defaults. If filenames collide, plugin versions take precedence.

Runtime Configuration

Toggle validators and reminders without editing files:

/ketchup:config show
/ketchup:config validators disable no-comments
/ketchup:config reminders priority my-reminder 200
/ketchup:config reminders add my-rule --hook UserPromptSubmit --priority 50 --content "Always use early returns"

Multiply with Git Worktrees

git worktree add ../feature-auth feature/auth
git worktree add ../feature-payments feature/payments

Each worktree runs its own Ketchup instance, all quality-validated.


Configuration

{
"validateCommit": { "mode": "strict", "batchCount": 3 },
"denyList": { "enabled": true },
"promptReminder": { "enabled": true },
"subagentHooks": {
"validateCommitOnExplore": false,
"validateCommitOnWork": true,
"validateCommitOnUnknown": true
}
}

Configuration lives in .ketchup/state.json. See the Configuration guide for all options.


How It Works

flowchart LR
A[Claude Code] --> B[Hook Scripts]
B --> C{Hook Type}
C -->|SessionStart| D[Load Reminders]
C -->|PreToolUse| E[Validate Commits + Deny-list]
C -->|UserPromptSubmit| F[Inject Reminders]
E -->|ACK| H[Allow]
E -->|NACK| I[Block + Revert]
Loading

Hook scripts read JSON from stdin, delegate to handlers in src/hooks/, log results, and output JSON to stdout. Validators are batched (default 3 per Claude CLI call) for efficient parallel validation. Reminders are matched by hook type, mode, and tool name, then injected as <system-reminder> blocks.


Roadmap

Ketchup is Claude Code-first today. The Ketchup Technique (the methodology) works with any AI coding agent by hand. If your agent exposes hooks or an equivalent integration surface, open an issue so we can scope adapter work.


Troubleshooting

Hooks Not Firing

Symptom: Commits go through without validation.

Cause: Plugin not installed or not enabled.

Solution:

/plugin install ketchup

Enable Debug Logging

DEBUG=ketchup claude --plugin-dir /path/to/ketchup

DEBUG=ketchup writes diagnostics to .ketchup/logs/ketchup/debug.log.


Documentation

GuideDescription
Getting StartedFirst-time setup and core concepts
InstallationDetailed installation guide
The Ketchup TechniqueThe planning methodology
In the StackHow Ketchup fits with Auto and spec-driven development
ConfigurationAll configuration options
Hooks GuideHook system deep-dive
Reminders GuideContext injection system
Validators GuideCommit validation rules
ArchitectureSystem design internals
Origin StoryHow Ketchup came to be

Architecture

.claude-plugin/
└── plugin.json # Plugin manifest (name, version, description)
hooks/
└── hooks.json # Plugin hook definitions (SessionStart, PreToolUse, etc.)
validators/ # Default commit validators
reminders/ # Default context-injection reminders (10 files)
agents/ # Sub-agent definitions (validator agent)
src/
├── brand.ts # BRAND constants (single source of truth for naming)
├── hooks/ # Hook handlers (session-start, pre-tool-use, user-prompt-submit)
├── migrate.ts # .claude-auto -> .ketchup auto-migration
├── path-resolver.ts # Plugin-mode path resolution
├── commit-validator.ts # Batched commit validation with appeal support
├── deny-list.ts # File protection via micromatch patterns
├── reminder-loader.ts # Multi-directory reminder system with deduplication
├── hook-state.ts # Hook state management (state.json)
├── validator-loader.ts # Multi-directory validator loader
└── index.ts # Public API barrel exports
scripts/
├── session-start.ts # SessionStart hook entry-point (runs migration first)
├── pre-tool-use.ts # PreToolUse hook entry-point
└── user-prompt-submit.ts # UserPromptSubmit hook entry-point

Dependencies

PackageUsage
gray-matterYAML frontmatter parsing for validators and reminders
micromatchGlob pattern matching for deny-lists

Development

Prerequisites

  • Node.js 18+
  • pnpm 10+

Setup

git clone https://github.com/BeOnAuto/ketchup.git
cd ketchup
pnpm install
pnpm build

Commands

CommandDescription
pnpm buildTypeScript compile + esbuild bundle scripts
pnpm testRun all tests (vitest)
pnpm type-checkTypeScript type checking
pnpm lintBiome lint check
pnpm checkFull CI: build + type-check + test + lint

License

MIT © 2025 BeOnAuto, Inc.

See LICENSE for details.

About

Turn every AI mistake into a rule AI can't repeat.

Resources

Stars

24 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Repository files navigation

Ketchup

Turn every AI mistake into a rule AI can't repeat.

Ketchup runs 20+ LLM-powered guardrails on every AI commit, so bad commits don't land.

BuildLicenseTypeScript

/plugin install ketchup

Ketchup is an open-source guardrail engine for Claude Code, from the team at Auto.

Today: Claude Code only. If your agent exposes hooks or an equivalent integration surface, open an issue.


Why

AI coding agents have three problems: they're biased for delivery, they have no negative knowledge about your system, and every prompt is a clean slate that forgets yesterday's lessons. Static tools (eslint, husky, commitlint) can't catch semantic failures: a test that asserts nothing, a commit that bundles three unrelated concerns, a "fix" that rationalizes a shortcut, an architectural rule violated three months after you wrote it.

Ketchup runs a separate Claude subagent against every commit, with your rules as its context and no investment in whether the commit ships. When it finds a violation, it blocks the commit and tells you why.

The workflow is: observe an AI mistake, encode it as a rule, AI can't repeat it. The codebase gets permanently safer as you keep working, not just temporarily cleaner. See Guardrail Engineering for the mechanism and the Ketchup Technique for the planning rhythm that feeds clean work into it.

In the stack

Ketchup comes from the team building Auto, a spec-driven development platform: Auto decides what to build, and Ketchup enforces how. Use them together or use Ketchup on its own; both work.

Key Concepts

  • Hooks: Three integration points (SessionStart, PreToolUse, UserPromptSubmit) that let Ketchup observe and gate Claude Code's behavior
  • Validators: Markdown files with YAML frontmatter that ACK or NACK commits based on your criteria
  • Reminders: Context-injection files that surface your guidelines at the right moment
  • Deny-list: Glob patterns that protect files from modification
  • TCR Discipline: Test && Commit || Revert, so bad code auto-reverts
  • Parallel subagent planning: ketchup-plan.md carries dependency notation so independent bursts launch in parallel sub-agents

Installation

From the Marketplace (recommended)

Inside any Claude Code session:

/plugin marketplace add BeOnAuto/auto-plugins
/plugin install ketchup

As a Local Plugin

claude --plugin-dir /path/to/ketchup

Claude Code sets CLAUDE_PLUGIN_ROOT and CLAUDE_PLUGIN_DATA automatically. Run /ketchup:init inside a session to activate per-project configuration, validators, and logging.

Quick Start

# Marketplace (inside Claude Code)
/plugin marketplace add BeOnAuto/auto-plugins
/plugin install ketchup
# Or local plugin mode
claude --plugin-dir /path/to/ketchup

After installation, Claude will mention that Ketchup is available. To activate it in a project:

/ketchup:init

This creates .ketchup/ with default configuration. You can add it to .gitignore for personal use, or commit it for the whole team.

If you're upgrading from claude-auto, your existing .claude-auto/ directory will be auto-renamed to .ketchup/ on first session-start. No manual action required.

Next steps:


Custom Validators and Reminders

Add project-specific rules by creating markdown files in .ketchup/validators/ and .ketchup/reminders/.

Custom Validator

Create .ketchup/validators/my-rule.md:

---name: my-ruledescription: Enforce my custom ruleenabled: true---
You are validating a git commit. Check that [your criteria here].
Respond with JSON only:
- If the commit passes: {"decision":"ACK"}
- If the commit fails: {"decision":"NACK","reason":"explanation"}

Validators receive the staged diff, file list, and commit message. They must return ACK or NACK as JSON.

Custom Reminder

Create .ketchup/reminders/my-reminder.md:

---when:
hook: UserPromptSubmitpriority: 50---
Your reminder content here. This gets injected on every prompt.

The when field controls when the reminder fires:

ConditionFires when
hook: SessionStartOnce at session start
hook: UserPromptSubmitEvery user prompt
hook: PreToolUseBefore tool execution
hook: PreToolUse + toolName: BashOnly before Bash tool
(no when)All hooks

Higher priority = appears first. Project-local files are loaded alongside plugin defaults. If filenames collide, plugin versions take precedence.

Runtime Configuration

Toggle validators and reminders without editing files:

/ketchup:config show
/ketchup:config validators disable no-comments
/ketchup:config reminders priority my-reminder 200
/ketchup:config reminders add my-rule --hook UserPromptSubmit --priority 50 --content "Always use early returns"

Multiply with Git Worktrees

git worktree add ../feature-auth feature/auth
git worktree add ../feature-payments feature/payments

Each worktree runs its own Ketchup instance, all quality-validated.


Configuration

{
"validateCommit": { "mode": "strict", "batchCount": 3 },
"denyList": { "enabled": true },
"promptReminder": { "enabled": true },
"subagentHooks": {
"validateCommitOnExplore": false,
"validateCommitOnWork": true,
"validateCommitOnUnknown": true
}
}

Configuration lives in .ketchup/state.json. See the Configuration guide for all options.


How It Works

flowchart LR
A[Claude Code] --> B[Hook Scripts]
B --> C{Hook Type}
C -->|SessionStart| D[Load Reminders]
C -->|PreToolUse| E[Validate Commits + Deny-list]
C -->|UserPromptSubmit| F[Inject Reminders]
E -->|ACK| H[Allow]
E -->|NACK| I[Block + Revert]
Loading

Hook scripts read JSON from stdin, delegate to handlers in src/hooks/, log results, and output JSON to stdout. Validators are batched (default 3 per Claude CLI call) for efficient parallel validation. Reminders are matched by hook type, mode, and tool name, then injected as <system-reminder> blocks.


Roadmap

Ketchup is Claude Code-first today. The Ketchup Technique (the methodology) works with any AI coding agent by hand. If your agent exposes hooks or an equivalent integration surface, open an issue so we can scope adapter work.


Troubleshooting

Hooks Not Firing

Symptom: Commits go through without validation.

Cause: Plugin not installed or not enabled.

Solution:

/plugin install ketchup

Enable Debug Logging

DEBUG=ketchup claude --plugin-dir /path/to/ketchup

DEBUG=ketchup writes diagnostics to .ketchup/logs/ketchup/debug.log.


Documentation

GuideDescription
Getting StartedFirst-time setup and core concepts
InstallationDetailed installation guide
The Ketchup TechniqueThe planning methodology
In the StackHow Ketchup fits with Auto and spec-driven development
ConfigurationAll configuration options
Hooks GuideHook system deep-dive
Reminders GuideContext injection system
Validators GuideCommit validation rules
ArchitectureSystem design internals
Origin StoryHow Ketchup came to be

Architecture

.claude-plugin/
└── plugin.json # Plugin manifest (name, version, description)
hooks/
└── hooks.json # Plugin hook definitions (SessionStart, PreToolUse, etc.)
validators/ # Default commit validators
reminders/ # Default context-injection reminders (10 files)
agents/ # Sub-agent definitions (validator agent)
src/
├── brand.ts # BRAND constants (single source of truth for naming)
├── hooks/ # Hook handlers (session-start, pre-tool-use, user-prompt-submit)
├── migrate.ts # .claude-auto -> .ketchup auto-migration
├── path-resolver.ts # Plugin-mode path resolution
├── commit-validator.ts # Batched commit validation with appeal support
├── deny-list.ts # File protection via micromatch patterns
├── reminder-loader.ts # Multi-directory reminder system with deduplication
├── hook-state.ts # Hook state management (state.json)
├── validator-loader.ts # Multi-directory validator loader
└── index.ts # Public API barrel exports
scripts/
├── session-start.ts # SessionStart hook entry-point (runs migration first)
├── pre-tool-use.ts # PreToolUse hook entry-point
└── user-prompt-submit.ts # UserPromptSubmit hook entry-point

Dependencies

PackageUsage
gray-matterYAML frontmatter parsing for validators and reminders
micromatchGlob pattern matching for deny-lists

Development

Prerequisites

  • Node.js 18+
  • pnpm 10+

Setup

git clone https://github.com/BeOnAuto/ketchup.git
cd ketchup
pnpm install
pnpm build

Commands

CommandDescription
pnpm buildTypeScript compile + esbuild bundle scripts
pnpm testRun all tests (vitest)
pnpm type-checkTypeScript type checking
pnpm lintBiome lint check
pnpm checkFull CI: build + type-check + test + lint

License

MIT © 2025 BeOnAuto, Inc.

See LICENSE for details.

About

Turn every AI mistake into a rule AI can't repeat.

Resources

Stars

24 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

Repository files navigation

Ketchup

Turn every AI mistake into a rule AI can't repeat.

Ketchup runs 20+ LLM-powered guardrails on every AI commit, so bad commits don't land.

BuildLicenseTypeScript

/plugin install ketchup

Ketchup is an open-source guardrail engine for Claude Code, from the team at Auto.

Today: Claude Code only. If your agent exposes hooks or an equivalent integration surface, open an issue.


Why

AI coding agents have three problems: they're biased for delivery, they have no negative knowledge about your system, and every prompt is a clean slate that forgets yesterday's lessons. Static tools (eslint, husky, commitlint) can't catch semantic failures: a test that asserts nothing, a commit that bundles three unrelated concerns, a "fix" that rationalizes a shortcut, an architectural rule violated three months after you wrote it.

Ketchup runs a separate Claude subagent against every commit, with your rules as its context and no investment in whether the commit ships. When it finds a violation, it blocks the commit and tells you why.

The workflow is: observe an AI mistake, encode it as a rule, AI can't repeat it. The codebase gets permanently safer as you keep working, not just temporarily cleaner. See Guardrail Engineering for the mechanism and the Ketchup Technique for the planning rhythm that feeds clean work into it.

In the stack

Ketchup comes from the team building Auto, a spec-driven development platform: Auto decides what to build, and Ketchup enforces how. Use them together or use Ketchup on its own; both work.

Key Concepts

  • Hooks: Three integration points (SessionStart, PreToolUse, UserPromptSubmit) that let Ketchup observe and gate Claude Code's behavior
  • Validators: Markdown files with YAML frontmatter that ACK or NACK commits based on your criteria
  • Reminders: Context-injection files that surface your guidelines at the right moment
  • Deny-list: Glob patterns that protect files from modification
  • TCR Discipline: Test && Commit || Revert, so bad code auto-reverts
  • Parallel subagent planning: ketchup-plan.md carries dependency notation so independent bursts launch in parallel sub-agents

Installation

From the Marketplace (recommended)

Inside any Claude Code session:

/plugin marketplace add BeOnAuto/auto-plugins
/plugin install ketchup

As a Local Plugin

claude --plugin-dir /path/to/ketchup

Claude Code sets CLAUDE_PLUGIN_ROOT and CLAUDE_PLUGIN_DATA automatically. Run /ketchup:init inside a session to activate per-project configuration, validators, and logging.

Quick Start

# Marketplace (inside Claude Code)
/plugin marketplace add BeOnAuto/auto-plugins
/plugin install ketchup
# Or local plugin mode
claude --plugin-dir /path/to/ketchup

After installation, Claude will mention that Ketchup is available. To activate it in a project:

/ketchup:init

This creates .ketchup/ with default configuration. You can add it to .gitignore for personal use, or commit it for the whole team.

If you're upgrading from claude-auto, your existing .claude-auto/ directory will be auto-renamed to .ketchup/ on first session-start. No manual action required.

Next steps:


Custom Validators and Reminders

Add project-specific rules by creating markdown files in .ketchup/validators/ and .ketchup/reminders/.

Custom Validator

Create .ketchup/validators/my-rule.md:

---name: my-ruledescription: Enforce my custom ruleenabled: true---
You are validating a git commit. Check that [your criteria here].
Respond with JSON only:
- If the commit passes: {"decision":"ACK"}
- If the commit fails: {"decision":"NACK","reason":"explanation"}

Validators receive the staged diff, file list, and commit message. They must return ACK or NACK as JSON.

Custom Reminder

Create .ketchup/reminders/my-reminder.md:

---when:
hook: UserPromptSubmitpriority: 50---
Your reminder content here. This gets injected on every prompt.

The when field controls when the reminder fires:

ConditionFires when
hook: SessionStartOnce at session start
hook: UserPromptSubmitEvery user prompt
hook: PreToolUseBefore tool execution
hook: PreToolUse + toolName: BashOnly before Bash tool
(no when)All hooks

Higher priority = appears first. Project-local files are loaded alongside plugin defaults. If filenames collide, plugin versions take precedence.

Runtime Configuration

Toggle validators and reminders without editing files:

/ketchup:config show
/ketchup:config validators disable no-comments
/ketchup:config reminders priority my-reminder 200
/ketchup:config reminders add my-rule --hook UserPromptSubmit --priority 50 --content "Always use early returns"

Multiply with Git Worktrees

git worktree add ../feature-auth feature/auth
git worktree add ../feature-payments feature/payments

Each worktree runs its own Ketchup instance, all quality-validated.


Configuration

{
"validateCommit": { "mode": "strict", "batchCount": 3 },
"denyList": { "enabled": true },
"promptReminder": { "enabled": true },
"subagentHooks": {
"validateCommitOnExplore": false,
"validateCommitOnWork": true,
"validateCommitOnUnknown": true
}
}

Configuration lives in .ketchup/state.json. See the Configuration guide for all options.


How It Works

flowchart LR
A[Claude Code] --> B[Hook Scripts]
B --> C{Hook Type}
C -->|SessionStart| D[Load Reminders]
C -->|PreToolUse| E[Validate Commits + Deny-list]
C -->|UserPromptSubmit| F[Inject Reminders]
E -->|ACK| H[Allow]
E -->|NACK| I[Block + Revert]
Loading

Hook scripts read JSON from stdin, delegate to handlers in src/hooks/, log results, and output JSON to stdout. Validators are batched (default 3 per Claude CLI call) for efficient parallel validation. Reminders are matched by hook type, mode, and tool name, then injected as <system-reminder> blocks.


Roadmap

Ketchup is Claude Code-first today. The Ketchup Technique (the methodology) works with any AI coding agent by hand. If your agent exposes hooks or an equivalent integration surface, open an issue so we can scope adapter work.


Troubleshooting

Hooks Not Firing

Symptom: Commits go through without validation.

Cause: Plugin not installed or not enabled.

Solution:

/plugin install ketchup

Enable Debug Logging

DEBUG=ketchup claude --plugin-dir /path/to/ketchup

DEBUG=ketchup writes diagnostics to .ketchup/logs/ketchup/debug.log.


Documentation

GuideDescription
Getting StartedFirst-time setup and core concepts
InstallationDetailed installation guide
The Ketchup TechniqueThe planning methodology
In the StackHow Ketchup fits with Auto and spec-driven development
ConfigurationAll configuration options
Hooks GuideHook system deep-dive
Reminders GuideContext injection system
Validators GuideCommit validation rules
ArchitectureSystem design internals
Origin StoryHow Ketchup came to be

Architecture

.claude-plugin/
└── plugin.json # Plugin manifest (name, version, description)
hooks/
└── hooks.json # Plugin hook definitions (SessionStart, PreToolUse, etc.)
validators/ # Default commit validators
reminders/ # Default context-injection reminders (10 files)
agents/ # Sub-agent definitions (validator agent)
src/
├── brand.ts # BRAND constants (single source of truth for naming)
├── hooks/ # Hook handlers (session-start, pre-tool-use, user-prompt-submit)
├── migrate.ts # .claude-auto -> .ketchup auto-migration
├── path-resolver.ts # Plugin-mode path resolution
├── commit-validator.ts # Batched commit validation with appeal support
├── deny-list.ts # File protection via micromatch patterns
├── reminder-loader.ts # Multi-directory reminder system with deduplication
├── hook-state.ts # Hook state management (state.json)
├── validator-loader.ts # Multi-directory validator loader
└── index.ts # Public API barrel exports
scripts/
├── session-start.ts # SessionStart hook entry-point (runs migration first)
├── pre-tool-use.ts # PreToolUse hook entry-point
└── user-prompt-submit.ts # UserPromptSubmit hook entry-point

Dependencies

PackageUsage
gray-matterYAML frontmatter parsing for validators and reminders
micromatchGlob pattern matching for deny-lists

Development

Prerequisites

  • Node.js 18+
  • pnpm 10+

Setup

git clone https://github.com/BeOnAuto/ketchup.git
cd ketchup
pnpm install
pnpm build

Commands

CommandDescription
pnpm buildTypeScript compile + esbuild bundle scripts
pnpm testRun all tests (vitest)
pnpm type-checkTypeScript type checking
pnpm lintBiome lint check
pnpm checkFull CI: build + type-check + test + lint

License

MIT © 2025 BeOnAuto, Inc.

See LICENSE for details.

About

Turn every AI mistake into a rule AI can't repeat.

Resources

Stars

24 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages