clerk

command module
v1.0.1-0...-d4f88a4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 16, 2026 License: GPL-3.0 Imports: 1 Imported by: 0

README

clerk

GitHub Release Go Version CI Go Report Card License

繁體中文 | 日本語 | 한국어

Your Claude Code sessions disappear when you close the terminal. clerk makes sure you never lose track of what you did.

The Problem

If you use Claude Code daily, you've hit these walls:

  • Lost context — You forgot -c or --resume, and now you're starting from scratch. Your previous session had all the context, but good luck finding it in a pile of session IDs.
  • Session chaos — Multiple projects, multiple sessions, all running in parallel. What did you do on the API server this morning? Which session had the auth fix? No idea.
  • Weekly report panic — Friday afternoon, time for the weekly report. You're digging through git log, trying to reconstruct what you actually did all week.
  • Manual bookkeeping — You told Claude to "save a summary" but forgot last time. Or the session crashed. Or you closed the terminal. The context is gone.

All of these boil down to one thing: Claude Code doesn't remember across sessions, and you shouldn't have to.

The Solution

clerk install

That's it. clerk hooks into Claude Code and works silently in the background:

Pain point How clerk solves it
Lost context /clerk-resume — instantly recover context from any previous session
Session chaos Auto-generated daily summaries per project, organized by date
Weekly reports Summaries + keyword tags = searchable work history via /clerk-search
Manual bookkeeping Fully automatic — no commands to remember, no habits to build

clerk is a set-and-forget tool. Install once, and every session is automatically summarized, tracked, tagged, and searchable. When you need context back, it's one slash command away.

Note: clerk is not an AI memory tool. Tools like claude-mem store context for AI to recall. clerk stores summaries for you to read — organized by date, searchable by keyword, ready for your weekly review.

Features

  • Auto-summarize — generates an incremental summary when your Claude Code session ends
  • Context recovery/clerk-resume to rebuild context from previous sessions
  • Keyword search/clerk-search to find past work by tag
  • Session tracking — records every session start for history lookup
  • Tag system — auto-extracts keywords from summaries for searchable indexing
  • Cursor tracking — only processes new messages since the last run, saving tokens and time
  • Process management — monitor active feeds, kill stuck processes, retry interrupted ones
  • Project-level config — disable feed per-project, override global settings
  • One-command setupclerk install wires up hooks, MCP server, and skills
  • Cross-platform: macOS, Linux, Windows
  • Shell completion (bash, zsh, fish, powershell)

How It Works

What gets installed
Component What it does
hook SessionStart records session ID, SessionEnd triggers summary generation
mcp MCP stdio server providing clerk-resume and clerk-search tools
skills /clerk-resume and /clerk-search slash commands for Claude Code
Summary flow
  1. Session ends → hook triggers clerk feed
  2. Feed forks to background (hook returns immediately)
  3. Reads only new messages since last run (cursor tracking)
  4. Loads existing daily summary, calls claude -p to merge
  5. Saves updated summary + extracts tags for search indexing
Resume flow
  1. You type /clerk-resume in Claude Code
  2. Claude calls the clerk-resume MCP tool with your project's working directory
  3. clerk returns file paths: daily summaries + full transcript files
  4. Claude reads the summaries first for a quick overview
  5. If more detail is needed, Claude reads the transcript files
  6. Claude summarizes what was previously done and confirms context is restored
Search flow
  1. You type /clerk-search in Claude Code
  2. Claude asks what keyword you're looking for (or you provide it as an argument)
  3. Claude calls the clerk-search MCP tool with the keyword
  4. clerk matches against tag index, returns paths to matching summaries and transcripts
  5. Claude reads the files and presents the relevant context
~/.clerk/
├── 20260416/
│   ├── projects-my-app.md
│   └── work-frontend.md
├── .sessions/
│   ├── projects-my-app.md
│   └── work-frontend.md
├── .tags/
│   ├── mcp.md
│   ├── refactor.md
│   └── auth.md
├── .log/
│   └── 20260416-clerk.log
├── .running/
└── .cursor/

Installation

Quick Install

macOS / Linux / Git Bash:

curl -fsSL https://raw.githubusercontent.com/vulcanshen/clerk/main/install.sh | sh

Windows (PowerShell):

irm https://raw.githubusercontent.com/vulcanshen/clerk/main/install.ps1 | iex

Then set up the hooks, MCP server, and skills:

clerk install
Package Managers
Platform Command
Homebrew (macOS / Linux) brew install vulcanshen/tap/clerk
Scoop (Windows) scoop bucket add vulcanshen https://github.com/vulcanshen/scoop-bucket && scoop install clerk
Debian / Ubuntu sudo dpkg -i clerk_<version>_linux_amd64.deb
RHEL / Fedora sudo rpm -i clerk_<version>_linux_amd64.rpm
Build from Source
go install github.com/vulcanshen/clerk@latest

Commands

Command Description
install Install all components (hook + mcp + skills)
install hook Install SessionStart/SessionEnd hooks only
install mcp Register MCP server only
install skills Install slash command skills only
uninstall Remove all components
config Show current configuration (alias for config show)
config show Show merged configuration and file paths
config set <key> <value> Set project-level config value
config set -g <key> <value> Set global config value
status Show active feed processes and interrupted sessions
status --watch Live-refresh status every second
retry <slug> Retry a specific interrupted session
retry --all Retry all interrupted sessions
kill <slug> Kill a specific active feed process
kill --all Kill all active feed processes

Internal commands (called by hooks, not by users):

Command Description
feed Process session transcript and generate summary
punch Record session ID on session start
mcp Start MCP stdio server

Configuration

Config files
  • Global: ~/.config/clerk/.clerk.json
  • Project: <cwd>/.clerk.json (overrides global)
Available settings
{
  "output": {
    "dir": "~/.clerk/",
    "language": "en"
  },
  "summary": {
    "model": ""
  },
  "log": {
    "retention_days": 30
  },
  "feed": {
    "enabled": true
  }
}
Key Default Description
output.dir ~/.clerk/ Root directory for summaries
output.language zh-TW Summary output language
summary.model "" (claude default) Model to use for claude -p
log.retention_days 30 Days to keep log and cursor files
feed.enabled true Enable/disable feed for this project
Examples
# Disable feed for a specific project
cd /path/to/unimportant-project
clerk config set feed.enabled false

# Use a cheaper model globally
clerk config set -g summary.model haiku

# Change output language globally
clerk config set -g output.language en

MCP Tools

Available when MCP server is installed (clerk install mcp):

Tool Description
clerk-resume Returns summary + transcript file paths for context recovery
clerk-search Search previous sessions by keyword/tag

Skills

Available when skills are installed (clerk install skills):

Skill Description
/clerk-resume Recover context from previous sessions — calls MCP tool, reads files, rebuilds context
/clerk-search Search past sessions by keyword — calls MCP tool, reads matching files

Troubleshooting

Logs are stored at ~/.clerk/.log/YYYYMMDD-clerk.log:

cat ~/.clerk/.log/$(date +%Y%m%d)-clerk.log

Common issues:

  • No summary generated — Check if claude is in your PATH
  • Hook cancelled — clerk forks to background to avoid this; update to latest version
  • MCP tool not found — Run clerk install mcp and restart the session

Shell Completion

# Zsh
mkdir -p ~/.zsh/completions
clerk completion zsh > ~/.zsh/completions/_clerk
echo 'fpath=(~/.zsh/completions $fpath)' >> ~/.zshrc
echo 'autoload -Uz compinit && compinit' >> ~/.zshrc
source ~/.zshrc

# Bash
clerk completion bash > /etc/bash_completion.d/clerk

# Fish
clerk completion fish > ~/.config/fish/completions/clerk.fish

# PowerShell
clerk completion powershell > clerk.ps1

License

GPL-3.0

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
internal
mcp

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL