What is weekly-git-summary CLAUDE.md?

Repository instructions for weekly-git-summary, a command-line tool that turns Git commit history into weekly reports. It documents the project, its features, build command, tests, filters, and output formats.

Use it when developing or testing weekly-git-summary, including date ranges, author or message filters, Conventional Commits analysis, and text, JSON, Markdown, or HTML reports.

It gives a coding agent the project context and the commands needed to build and check the tool. This reduces guesswork when working in the repository.

How yinzhenyu-su/weekly-git-summary configures Claude Code

Reuse

Borrowing it

Nothing to install: this file belongs to yinzhenyu-su/weekly-git-summary. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file

curl -O https://raw.githubusercontent.com/yinzhenyu-su/weekly-git-summary/main/CLAUDE.md

Clone the repo

git clone --depth 1 https://github.com/yinzhenyu-su/weekly-git-summary

Made for: Claude Code.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/yinzhenyu-su/weekly-git-summary/claude-md/github.svg)](https://agentmods.dev/instructions/yinzhenyu-su/weekly-git-summary/claude-md)

Your own site

<a href="https://agentmods.dev/instructions/yinzhenyu-su/weekly-git-summary/claude-md"><img src="https://agentmods.dev/badge/instructions/yinzhenyu-su/weekly-git-summary/claude-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/yinzhenyu-su/weekly-git-summary/claude-md"><img src="https://agentmods.dev/badge/instructions/yinzhenyu-su/weekly-git-summary/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 2,716 This file is loaded in full into every session.

When invoked 2,716 The same file — it is already loaded in full.

Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.

Origin original No closer match found in the catalogue.

Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

Model	Per session	Once invoked
Fable 5.1	$0.02716	$0.02716
Opus 5.5	$0.01086	$0.01086
Sonnet 5.5	$0.00543	$0.00543
Haiku 4.5	$0.00272	$0.00272

Measured 2mo ago against content hash e286365a0c29, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

weekly-git-summary CLAUDE.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2mo ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

CLAUDE.md · 259 lines

How it starts

The opening of the file, as written. The whole thing — 259 lines — stays where its author put it; the contents beside it link to each section on GitHub.

CLAUDE.md

该文件为 Claude Code (claude.ai/code) 在此代码库中工作时提供指导。

项目概述

这是 weekly-git-summary，一个跨平台的 CLI 工具，用于生成 Git 提交记录的周报汇总。它自动扫描 Git 仓库，提取指定日期范围内的提交历史，并以多种格式输出结果（文本、JSON、Markdown、HTML）。

主要特性

多维度过滤: 支持多作者过滤、消息模式匹配（正则表达式）
传统提交规范: 支持 Conventional Commits 解析和统计分析
时间范围预设: 支持预设时间范围（today, this-week, last-month 等）
统计分析: 提供提交统计、参与者分析、类型分布等
国际化文档: 完整的中英文文档支持

关键命令

构建和开发

# 构建 CLI 工具
bun run build.ts

# 构建脚本从 scripts/cli.ts 创建 build/cli.js
# 使用 Bun 的构建 API，ESM 格式，目标为 Node.js

测试 CLI

# 构建后，本地测试 CLI
node build/cli.js --help

# 使用参数测试
node build/cli.js -d ~/projects -s 2023-01-01 -u 2023-01-31
node build/cli.js --json
node build/cli.js --md
node build/cli.js --html

# 新功能测试 - 时间范围预设
node build/cli.js --time-range today
node build/cli.js --time-range this-week
node build/cli.js --time-range last-month

# 传统提交规范分析
node build/cli.js --conventional --time-range this-week

# 消息模式过滤（支持正则表达式）
node build/cli.js --message-pattern "feat|fix" --conventional
node build/cli.js --message-pattern "用户|登录|认证"

# 目录路径 - 支持包含空格的路径（多种转义方式）
node build/cli.js -d "Program Files/MyProject"       # 引号包裹
node build/cli.js --dir "My\ Documents/Projects"     # 引号内反斜杠转义
node build/cli.js --dir "/Library/Application\ Support"  # 多个反斜杠转义

# 作者过滤 - 支持多个作者和空格名称（多种转义方式）
node build/cli.js -a "John Doe"                    # 单个作者（引号包裹）
node build/cli.js --author "Zhang San"             # 单个作者（引号包裹）
node build/cli.js --author 'Li Ming Wang'          # 单个作者（单引号包裹）
node build/cli.js -a "John\ Doe"                   # 单个作者（引号内反斜杠转义）
node build/cli.js -a "Alice" -a "Bob"              # 多个作者过滤（OR 关系）
node build/cli.js -a "John Doe" --author "Jane Smith"  # 混合使用短参数和长参数
node build/cli.js -a "Dr\ John\ Doe" -a "Mary\ Jane\ Watson"  # 多个作者反斜杠转义

架构设计

跨平台策略

项目使用 TypeScript CLI 包装器（scripts/cli.ts）：

使用 os.platform() 检测操作系统
自动委托给平台特定的脚本：
- Windows: weekly-git-summary.js (Node.js) - 不再依赖 PowerShell
- macOS/Linux: weekly-git-summary.sh (Bash) 或回退到 weekly-git-summary.js (Node.js)
透明地将所有命令行参数传递给底层脚本

Read the full file on GitHub · 259 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

2mo ago First seen · 259 lines · 2,716 tokens per session scan A e286365a0c29

Subscribe to this mod's changes

weekly-git-summary CLAUDE.md is an instructions file published in the GitHub repository yinzhenyu-su/weekly-git-summary (203 stars, last pushed 2mo ago), licensed MIT. It adds 2,716 tokens to every session, about $0.0109 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Git and workflow bunjs shell-script weekly-reports

weekly-git-summary CLAUDE.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
weekly-git-summary CLAUDE.mdyinzhenyu-su/weekly-git-summary	Instructions file	203	2mo ago	MIT	A	2,716	Claude Code
vscode buildNext.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	9,719	GitHub Copilot
next.js AGENTS.mdvercel/next.js	Instructions file	143k	today	MIT	A	7,461	Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchain	Instructions file	149k	yesterday	MIT	A	4,680	Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	5,516	GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	3,093	GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harness	Instructions file	274k	2d ago	MIT	A	4,313	Codex, OpenCode

weekly-git-summary: Instructions file for Claude Code