Ryan Malloy
9445e09c48
Major changes: - Add package.json with NPM packaging configuration - Create Node.js CLI interface (bin/claude-hooks.js) with full command set - Convert bash scripts to Python for better npm integration - Add npm postinstall/preuninstall hooks for automatic setup - Update bootstrap prompt to recommend NPM method with git fallback - Enhance README with NPM-first documentation - Maintain backward compatibility with existing git installation Features: - npm install -g claude-hooks for easy distribution - claude-hooks init/status/test/backup/uninstall commands - Automatic Python dependency installation - Conflict detection and prevention - Hybrid approach supporting both npm and git workflows This resolves installation complexity while maintaining developer flexibility. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
Claude Code Hooks Documentation
This documentation is organized using the Diátaxis framework to serve different types of user needs.
📚 Documentation Types
🎓 Tutorial
Learning-oriented - For newcomers who want to gain confidence and skill
Start here if you're new to Claude Hooks. We'll guide you through your first experience, showing you how the system works by watching it in action.
Time commitment: 30-45 minutes
What you'll gain: Confidence using Claude with intelligent assistance
🛠️ How-To Guides
Task-oriented - For competent users solving specific problems
Choose the guide that matches your current need:
- How to restore from backups - When your session crashed or you need to recover work
- How to customize command patterns - Add your own dangerous command patterns or warnings
- How to share learned patterns - Share intelligence with your team or across projects
📖 Reference
Information-oriented - For looking up facts while working
Quick reference for when you need specific details:
- CLI Commands - Complete command reference with options and examples
- Hook API - Technical specification for hook input/output
💡 Explanation
Understanding-oriented - For gaining deeper insight
Read when you want to understand the "why" behind Claude Hooks:
- Why Claude Code needs intelligent hooks - The problems that Claude Hooks solves
- Understanding the shadow learner - How the system builds intelligence through observation
- The architecture of intelligent assistance - How the components work together to create emergent intelligence
🚀 Quick Start
New to Claude Hooks? → Start with the Tutorial
Need to solve a problem? → Check the How-To Guides
Looking up syntax or options? → Use the Reference
Want to understand how it works? → Read the Explanations
🤔 Which Type of Documentation Do I Need?
Use this decision tree:
Are you currently working on a task?
├─ Yes → Do you know what you want to accomplish?
│ ├─ Yes → How-To Guides 📋
│ └─ No → Reference 📖
└─ No → Are you learning or exploring?
├─ Learning → Tutorial 🎓
└─ Understanding → Explanation 💡
📁 Project Navigation
- Main README - Project overview and installation
- DEMO - Quick feature showcase
- Architecture - Technical architecture details
🔍 Finding What You Need
Can't find what you're looking for?
- Search tip: Use your browser's find function (Ctrl+F / Cmd+F) on the reference pages
- GitHub search: Use the repository search to find specific terms across all documentation
- Start broader: If a specific how-to doesn't exist, try the tutorial or explanation first
Common documentation patterns:
- All tutorials use "we" language and step-by-step instruction
- All how-to guides start with "when to use this guide"
- All reference pages are organized alphabetically and consistently formatted
- All explanations can be read away from the computer
This organization ensures you get the right type of help for your current situation.