Claude Code boilerplate generator — scaffolds CLAUDE.md, repo-namespaced skills, settings, hooks, and CI workflows
Project description
klaussy
Claude Code boilerplate generator. One command to make any repo Claude Code-ready.
Install
pip install klaussy
Requires klaussy-repo-conventions (installed automatically).
Quick Start
cd your-repo
klaussy init
That's it. You'll be prompted for your base branch (auto-detects dev, main, etc.), then klaussy generates everything.
What Gets Generated
CLAUDE.md # Repo conventions, project-wide section (via klaussy-repo-conventions)
.claude/
├── settings.json # Tool permissions + deny rules + PreToolUse/PostToolUse hooks
├── hooks/
│ ├── read_injection_guard.py # Scans Read/WebFetch content for prompt-injection markers
│ └── git_commit_guard.py # Runs format + lint when Claude tries to `git commit`
├── rules/
│ └── <glob-stem>.md # Path-scoped rule buckets (zero or more, emitted by klaussy-repo-conventions 1.4+)
└── skills/
├── .klaussy-version # Marker tracking which klaussy version generated the skills
├── <repo>-review/SKILL.md # PR review with parallel sub-agents and repo-specific checks
├── <repo>-plan/SKILL.md # Multi-phase plan + implement (discovery, parallel architects, review)
├── <repo>-debug/SKILL.md # Debug an error with root-cause analysis and a failing test
├── <repo>-implement/SKILL.md # Implement a pasted ticket/design with plan-mode investigation
├── <repo>-refactor/SKILL.md # Refactor code while preserving behavior, test-backed
├── <repo>-test/SKILL.md # Write tests for current changes
├── <repo>-fix/SKILL.md # Fix lint/format/type errors
├── <repo>-pr/SKILL.md # Generate a PR description
├── <repo>-commit/SKILL.md # Generate a commit message
├── <repo>-explain/SKILL.md # Explain code or current diff
└── <repo>-new-worktree/SKILL.md # Create a git worktree for a task
.github/
└── PULL_REQUEST_TEMPLATE.md # Only if repo doesn't have one
.gitignore # Appends klaussy output exclusions
What each piece does
CLAUDE.md — Auto-detected conventions, architecture, commands, and pitfalls for your repo. As of 0.2.0 path-scoped rules are split out into individual files under .claude/rules/<glob-stem>.md (each with paths: frontmatter) so rules apply where they belong instead of as a flat list — CLAUDE.md itself holds the project-wide content. This is what Claude Code reads to understand your project.
settings.json — Auto-detects your stack (Python, Node, Go, Rust, Make) and sets tool permissions. Detects sensitive files (.env, *.pem, credentials*) and adds deny rules so Claude can't read them.
Skills — Each repo gets a set of namespaced skills (<repo>-<skill>) so Claude Code auto-triggers them by description and they don't collide across repos. The bundled set is listed below; the canonical list lives in SKILL_NAMES in src/klaussy/skills.py.
| Skill | What it does | Output |
|---|---|---|
<repo>-review |
Senior-level PR review against your base branch. Small PRs get a single-pass review; larger PRs fan out to parallel sub-agents (correctness, architecture, security, scope, plus an Agentic & Evals lens when the diff touches AI/agent/eval code) with a validation phase that removes false positives | REVIEW_OUTPUT.md |
<repo>-plan |
Multi-phase task planning + implementation: discovery → parallel exploration → clarify → parallel architectures → approval → implement → parallel review → summary. The approved plan is written to plan.md and used as a resumable checklist |
plan.md |
<repo>-test |
Writes tests for current changes matching your repo's test patterns. Covers happy path, edge cases, and error paths without over-mocking | — |
<repo>-fix |
Fixes all lint, format, and type errors | — |
<repo>-pr |
Generates a ready-to-paste PR description | pr-description.md |
<repo>-commit |
Generates a commit message from staged changes | — |
<repo>-debug |
Five-phase debug flow: reproduce, diagnose root cause, write a failing test, fix, verify against the full suite | — |
<repo>-implement |
Implements a pasted ticket or design doc. Uses plan mode to investigate and plan before editing, enforces scope rules, and writes failing tests first for bug fixes | — |
<repo>-refactor |
Refactors code while preserving behavior exactly. Requires a passing test baseline, runs tests between every incremental step | — |
<repo>-new-worktree |
Creates a git worktree with a branch named for your task | — |
<repo>-explain |
Explains code or concept; defaults to explaining the current diff | — |
Git-commit guard — A PreToolUse hook on Bash that watches for git commit invocations. When Claude is about to commit, the guard runs your auto-detected format + lint commands and blocks the commit on any non-zero exit. Project-specific commands are baked into .claude/hooks/git_commit_guard.py at scaffold time.
Read-injection guard — A PreToolUse hook (for Read) and PostToolUse hook (for WebFetch) that scans content for prompt-injection markers (ignore previous instructions, ChatML/Llama control tokens, role-prefix injection, persona reassignment) before Claude consumes it. Local files matching the patterns are blocked; web responses are surfaced back as untrusted-content warnings. Pure-stdlib Python so the repo stays portable. Lives at .claude/hooks/read_injection_guard.py.
PR template — A basic PR template, only created if your repo doesn't already have one (checks root, .github/, and docs/).
.gitignore — Appends pr-description.md, REVIEW_OUTPUT.md, and plan.md so generated outputs don't get committed.
Migrating from 0.1.x
If you ran an earlier version of klaussy, you have .claude/commands/*.md files. On the next klaussy init (with 0.2.0+) those files — and only the ones klaussy itself created (tracked via .claude/commands/.klaussy-version) — are removed and replaced with .claude/skills/<repo>-<skill>/SKILL.md. Any commands you wrote yourself are left alone.
If you've already klaussified at 0.2.0+ and want to refresh after upgrading klaussy itself, use klaussy init --force (or the klaussy-update skill if you have the plugin installed).
Options
klaussy init [OPTIONS]
Options:
-r, --repo PATH Target repository (default: current directory)
-f, --force Overwrite existing files
-b, --base-branch TEXT Base branch for diffs (default: auto-detect, prompts)
--skip-enrich Skip Claude CLI enrichment (faster, no API call)
--review-template PATH Use a custom review prompt instead of the default
Custom review template
If your team has a specific review checklist (e.g. domain-specific checks, security requirements), pass it in:
klaussy init --review-template path/to/your-review.md
The template will be used as the body of the <repo>-review skill instead of the default. Custom templates are responsible for supplying their own SKILL.md frontmatter.
Individual Commands
You can run each step individually:
klaussy checklist # Regenerate the review skill from CLAUDE.md
klaussy skills # Regenerate all skills
klaussy settings # Regenerate settings.json
klaussy hooks # Regenerate hook configs
klaussy github # Regenerate PR template
All subcommands support --repo, --force, and --base-branch where applicable.
How It Works
- Runs
conventions discover --claude --initto analyze your codebase and generateCLAUDE.mdwith path-scoped conventions and architecture sections - Parses
CLAUDE.mdto extract conventions, commands, and pitfalls (including which file globs each rule applies to) - Injects those into the review skill template so
<repo>-reviewchecks repo-specific rules with the right path scope - Detects your stack from marker files (
pyproject.toml,package.json,go.mod, etc.) - Sets permissions, deny rules, and hooks based on what it finds
- Skips anything that already exists (PR template) unless
--forceis used
Claude Code Integration
klaussy can be used three ways with Claude Code:
As a CLI (simplest)
pip install klaussy
klaussy init
As a Claude Code Plugin
Add the klaussy marketplace, then install the plugin:
/plugin marketplace add steph-dove/klaussy
/plugin install klaussy@klaussy
This gives you two plugin-level skills — klaussy-init (scaffold a fresh repo) and klaussy-update (refresh generated boilerplate after upgrading klaussy) — plus the MCP server. The plugin manifest lives in .claude-plugin/plugin.json and the marketplace entry in .claude-plugin/marketplace.json.
As an MCP Server
Add klaussy as an MCP server so Claude can invoke it directly:
pip install klaussy[mcp]
claude mcp add --transport stdio klaussy -- klaussy-mcp
Or add to your project's .mcp.json:
{
"mcpServers": {
"klaussy": {
"command": "klaussy-mcp",
"env": { "PYTHONUNBUFFERED": "1" }
}
}
}
The MCP server exposes these tools: klaussy_init, klaussy_checklist, klaussy_skills, klaussy_settings, klaussy_status.
Requirements
- Python 3.10+
- klaussy-repo-conventions >= 1.4.0
- Claude Code CLI (optional, for
--initenrichment) - mcp (optional, for MCP server:
pip install klaussy[mcp])
Contributing
See CONTRIBUTING.md for contributor guidelines.
License
MIT — see LICENSE for details.
Ownership and Governance
klaussy is an open-source project owned and maintained by Dovatech LLC.
Dovatech LLC is a privately held company founded and wholly owned by Stephanie Dover, who is also the original author and lead maintainer of this project.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file klaussy_agents-0.2.1.tar.gz.
File metadata
- Download URL: klaussy_agents-0.2.1.tar.gz
- Upload date:
- Size: 56.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
080d23117a6a9f7d416d73c272e61061e0276b23cb555adfc794017dbd5c8eec
|
|
| MD5 |
53dffd4bfa36bf40f1e31b66ce2c544a
|
|
| BLAKE2b-256 |
bbb971e485c6e0faf2ad208f6a77ea321c968140a8c9663c690e178ec340dc6f
|
File details
Details for the file klaussy_agents-0.2.1-py3-none-any.whl.
File metadata
- Download URL: klaussy_agents-0.2.1-py3-none-any.whl
- Upload date:
- Size: 60.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5c0c7576c1b156ee75c4f1729fd703da5cf4ea188f5b8fe7d6d333140643018d
|
|
| MD5 |
ece0da68f3dba0af55f1dfb12fe27677
|
|
| BLAKE2b-256 |
e92c92225cb50ed21eb8fb3b4c8081a5d9d7b504144adfa4b3d79255fc172d5f
|