Skip to content

Commit 8494213

Browse files
feat: add LICENSE, CI, CONTRIBUTING, and promote live AI monitor
- Add MIT LICENSE (Copyright 2026 TheDecipherist) - Add .claude/settings.local.json.example for personal hook overrides - Add GitHub Actions CI workflow (typecheck + unit tests on PRs) - Add CONTRIBUTING.md with issue/PR guidelines - Add "See It In Action" demo placeholder section to README - Promote /what-is-my-ai-doing in README and docs (dedicated feature card, moved to position 3 in commands, added highlight callout) - Make GitHub Pages link more prominent with blockquote callout - Add CI status badge to README Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent a590cf2 commit 8494213

7 files changed

Lines changed: 196 additions & 15 deletions

File tree

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
{
2+
"_comment": [
3+
"Personal hook overrides — copy this file to .claude/settings.local.json",
4+
"which is gitignored. Your overrides here won't affect the team config.",
5+
"",
6+
"To use: cp .claude/settings.local.json.example .claude/settings.local.json",
7+
"Then edit .claude/settings.local.json with your personal preferences."
8+
],
9+
10+
"hooks": {
11+
"PreToolUse": [
12+
{
13+
"_comment": "Example: override the default hook timeout (milliseconds)",
14+
"matcher": "Write",
15+
"hooks": [
16+
{
17+
"type": "command",
18+
"command": "echo 'Pre-write check'",
19+
"timeout": 15000
20+
}
21+
]
22+
}
23+
],
24+
"PostToolUse": [
25+
{
26+
"_comment": "Example: personal post-tool hook (e.g., notify, log, or format)",
27+
"matcher": "Write",
28+
"hooks": [
29+
{
30+
"type": "command",
31+
"command": "date '+%H:%M:%S file written' >> /tmp/claude-hook-log.txt"
32+
}
33+
]
34+
}
35+
]
36+
},
37+
38+
"env": {
39+
"_comment": "Example: personal environment variables for hooks and scripts",
40+
"MY_EDITOR": "code",
41+
"LINT_ON_SAVE": "true"
42+
}
43+
}

.github/workflows/ci.yml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: CI
2+
3+
on:
4+
pull_request:
5+
branches: [main]
6+
7+
jobs:
8+
check:
9+
runs-on: ubuntu-latest
10+
11+
steps:
12+
- uses: actions/checkout@v4
13+
14+
- uses: pnpm/action-setup@v4
15+
with:
16+
version: 9
17+
18+
- uses: actions/setup-node@v4
19+
with:
20+
node-version: 20
21+
cache: pnpm
22+
23+
- run: pnpm install --frozen-lockfile
24+
25+
- name: TypeScript type-check
26+
run: pnpm typecheck
27+
28+
- name: Unit tests
29+
run: pnpm test:unit

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ service-account.json
99

1010
# Claude Code personal overrides
1111
CLAUDE.local.md
12+
.claude/settings.local.json
1213

1314
# Dependencies
1415
node_modules/

CONTRIBUTING.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Contributing
2+
3+
Thanks for your interest in improving the Claude Code Starter Kit.
4+
5+
## Reporting Issues
6+
7+
Use [GitHub Issues](../../issues). Include:
8+
- Claude Code version (`claude --version`)
9+
- OS and environment (macOS, Linux, WSL2)
10+
- Steps to reproduce
11+
- Expected vs actual behavior
12+
13+
## Submitting Changes
14+
15+
1. Fork the repo
16+
2. Create a branch from `main` (`git checkout -b feat/your-change`)
17+
3. Make your changes
18+
4. Run `pnpm test` to verify all tests pass
19+
5. Run the `/review` slash command in Claude Code on every file you changed
20+
6. Open a PR against `main`
21+
22+
## What's Welcome
23+
24+
- New slash commands (`.claude/commands/`)
25+
- New skills (`.claude/skills/`)
26+
- New hooks (`.claude/hooks/`)
27+
- Documentation improvements
28+
- Bug fixes
29+
- Test coverage improvements
30+
31+
## What's NOT Welcome
32+
33+
- Framework-specific opinions — keep it stack-agnostic where possible
34+
- Removing existing rules without discussion — open an issue first
35+
- Large refactors without a prior issue/discussion
36+
37+
## Code Style
38+
39+
- TypeScript strict mode for all new files
40+
- Follow the existing patterns in the project
41+
- No file > 300 lines, no function > 50 lines
42+
- Run `/review` before submitting your PR
43+
- See `CLAUDE.md` for the full coding standards
44+
45+
## License
46+
47+
By contributing, you agree that your contributions will be licensed under the same license as this project (see [LICENSE](LICENSE)).
48+
49+
## Credit
50+
51+
Contributors are acknowledged in README.md and the [GitHub Pages site](https://thedecipherist.github.io/claude-code-mastery-project-starter-kit/).
52+
53+
## Context
54+
55+
This project implements patterns from the [Claude Code Mastery Guide](https://github.com/TheDecipherist/claude-code-mastery). Understanding V3-V5 helps explain why rules exist the way they do.

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 TheDecipherist
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# Claude Code Starter Kit
22

3-
### [View the Full Interactive Guide →](https://thedecipherist.github.io/claude-code-mastery-project-starter-kit/)
3+
[![CI](https://github.com/TheDecipherist/claude-code-mastery-project-starter-kit/actions/workflows/ci.yml/badge.svg)](https://github.com/TheDecipherist/claude-code-mastery-project-starter-kit/actions/workflows/ci.yml)
4+
5+
> ## [View the Full Interactive Guide →](https://thedecipherist.github.io/claude-code-mastery-project-starter-kit/)
6+
>
7+
> The GitHub Pages site has the complete documentation with syntax highlighting, navigation, and visual examples. The README below is a summary.
48
59
> The definitive starting point for Claude Code projects.
610
> Based on [Claude Code Mastery Guides V3-V5](https://github.com/TheDecipherist/claude-code-mastery) by TheDecipherist.
@@ -11,6 +15,16 @@
1115

1216
This is a **ready-to-use project template** that bakes in every best practice from the Claude Code Mastery Guide series (V3, V4, and V5). Instead of reading 4,000+ lines of guides and setting things up yourself, clone this and start building.
1317

18+
## See It In Action
19+
20+
<!-- Record with: asciinema rec demo.cast && agg demo.cast docs/demo.gif -->
21+
![Starter Kit Demo](docs/demo.gif)
22+
23+
*Clone → `/setup``/diagram all` → hooks firing on file edit → `/review` catching issues*
24+
25+
<!-- Capture /progress output as a screenshot -->
26+
![Slash Commands](docs/commands-preview.png)
27+
1428
## What's Included
1529

1630
### 📄 CLAUDE.md (Project Instructions)
@@ -28,6 +42,9 @@ Security gatekeeper that applies to ALL your projects:
2842
- New project scaffolding standards
2943
- Copy `global-claude-md/` contents to `~/.claude/`
3044

45+
### 📡 Live AI Monitor
46+
See every tool call, token, cost, and violation in real-time with `/what-is-my-ai-doing`. Zero token overhead — runs completely outside Claude's context.
47+
3148
### 🪝 Hooks (Deterministic Enforcement)
3249
CLAUDE.md rules are suggestions. Hooks are guarantees:
3350
- **block-secrets.py** — Prevents reading .env, credentials, SSH keys
@@ -36,6 +53,9 @@ CLAUDE.md rules are suggestions. Hooks are guarantees:
3653

3754
### ⚡ Commands (Slash Commands)
3855
On-demand tools you invoke with `/command`:
56+
- `/setup` — Interactive .env configuration (database, GitHub, Docker, analytics)
57+
- `/diagram` — Auto-generate architecture, API, database, and infrastructure diagrams
58+
- `/what-is-my-ai-doing` — Live monitor of every tool call, token, cost, and violation in real-time
3959
- `/review` — Code review with security, performance, and type safety checks
4060
- `/commit` — Smart commit with conventional commit format
4161
- `/progress` — Real-time project status from filesystem state

docs/index.html

Lines changed: 26 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -246,6 +246,14 @@ <h3>Documentation</h3>
246246
<h3>Testing Templates</h3>
247247
<p>Master test checklist, issue tracking log, and a singleton database wrapper that prevents connection pool explosion. All inputs are auto-sanitized against NoSQL injection.</p>
248248
</div>
249+
250+
<div class="feature-card">
251+
<div class="feature-icon feature-icon-amber">
252+
<svg width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><rect x="2" y="3" width="20" height="14" rx="2" ry="2"/><line x1="8" y1="21" x2="16" y2="21"/><line x1="12" y1="17" x2="12" y2="21"/></svg>
253+
</div>
254+
<h3>Live AI Monitor</h3>
255+
<p>See every tool call, token, cost, and violation in real-time with <code>/what-is-my-ai-doing</code>. Zero token overhead &mdash; runs completely outside Claude's context.</p>
256+
</div>
249257
</div>
250258
</section>
251259

@@ -729,6 +737,10 @@ <h3>Hook Configuration</h3>
729737
<h2>Slash Commands &mdash; On-Demand Tools</h2>
730738
<p>Invoke these with <code>/command</code> in any Claude Code session. Each command is a markdown file in <code>.claude/commands/</code> that gives Claude specific instructions and tool permissions.</p>
731739

740+
<div class="callout" style="background: var(--bg-secondary); border-left: 4px solid var(--accent-amber); padding: 1rem 1.25rem; border-radius: 0.5rem; margin-bottom: 1.5rem;">
741+
<strong>New:</strong> See everything your AI does in real-time &rarr; <code>/what-is-my-ai-doing</code>
742+
</div>
743+
732744
<div class="commands-grid">
733745
<div class="command-card">
734746
<h3><code>/diagram</code></h3>
@@ -771,6 +783,20 @@ <h3><code>/setup</code></h3>
771783
<p>Skips variables that already have values. Use <code>/setup --reset</code> to re-configure everything. Never displays secrets back to you. Keeps <code>.env.example</code> in sync.</p>
772784
</div>
773785

786+
<div class="command-card">
787+
<h3><code>/what-is-my-ai-doing</code></h3>
788+
<p class="command-desc">Launches the RuleCatch AI-Pooler live monitor in a separate terminal. See everything your AI is doing in real time:</p>
789+
<ul>
790+
<li>Every tool call (Read, Write, Edit, Bash)</li>
791+
<li>Token usage and cost per turn</li>
792+
<li>Rule violations as they happen</li>
793+
<li>Which files are being accessed</li>
794+
</ul>
795+
<pre class="language-bash"><code class="language-bash"># Run in a separate terminal
796+
npx @rulecatch/ai-pooler@latest monitor -v</code></pre>
797+
<p>Zero token overhead &mdash; runs completely outside Claude's context. Also available as <code>pnpm ai:monitor</code>.</p>
798+
</div>
799+
774800
<div class="command-card">
775801
<h3><code>/review</code></h3>
776802
<p class="command-desc">Systematic code review against a 7-point checklist:</p>
@@ -825,20 +851,6 @@ <h3><code>/architecture</code></h3>
825851
<p class="command-desc">Reads <code>project-docs/ARCHITECTURE.md</code> and displays the system overview, data flow diagrams, and service responsibility maps. If docs don't exist, scaffolds them.</p>
826852
</div>
827853

828-
<div class="command-card">
829-
<h3><code>/what-is-my-ai-doing</code></h3>
830-
<p class="command-desc">Launches the RuleCatch AI-Pooler live monitor in a separate terminal. See everything your AI is doing in real time:</p>
831-
<ul>
832-
<li>Every tool call (Read, Write, Edit, Bash)</li>
833-
<li>Token usage and cost per turn</li>
834-
<li>Rule violations as they happen</li>
835-
<li>Which files are being accessed</li>
836-
</ul>
837-
<pre class="language-bash"><code class="language-bash"># Run in a separate terminal
838-
npx @rulecatch/ai-pooler@latest monitor -v</code></pre>
839-
<p>Zero token overhead &mdash; runs completely outside Claude's context. Also available as <code>pnpm ai:monitor</code>.</p>
840-
</div>
841-
842854
<div class="command-card">
843855
<h3><code>/worktree</code></h3>
844856
<p class="command-desc">Creates an isolated git worktree + branch for a task:</p>

0 commit comments

Comments
 (0)