Skip to content

Commit 52248e4

Browse files
sjnimsclaude
andauthored
docs: add prerequisites section for utility script dependencies (#157)
## Description Add documentation for utility script dependencies (jq, grep, sed) so users know what tools are required before running validation scripts. ## Type of Change - [x] Documentation update (improvements to README, CLAUDE.md, or component docs) ## Component(s) Affected - [x] Skills (methodology and best practices) - [x] Documentation (README.md, CLAUDE.md, SECURITY.md) ## Motivation and Context Users may encounter confusing errors if external tools like `jq` are missing. This documents the requirements upfront. Fixes #152 ## Solution - **README.md**: Added "For Utility Scripts" subsection to Prerequisites with tool/version table, environment check commands, and installation note - **hook-development/SKILL.md**: Added prerequisites blockquote referencing the main README ### Note on Bash Version The issue originally suggested bash 4.0+ but I verified the scripts only use `[[ =~ ]]` regex matching which is available in bash 3.2+ (macOS default). Updated accordingly. ## Changes - `README.md`: Added utility script prerequisites section - `plugins/plugin-dev/skills/hook-development/SKILL.md`: Added prerequisites note ## Testing - [x] Linting passes (markdownlint) - [x] Verified bash version requirement by grepping for 4.0+ features (none found) --- 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude <noreply@anthropic.com>
1 parent 9e4cef2 commit 52248e4

2 files changed

Lines changed: 25 additions & 1 deletion

File tree

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,32 @@ Each component follows progressive disclosure: lean core documentation with deta
4242

4343
## Prerequisites
4444

45+
### Required
46+
4547
- [Claude Code CLI](https://docs.anthropic.com/en/docs/claude-code) installed and configured
46-
- Bash shell (for utility scripts)
4748
- Git (for version control and marketplace publishing)
4849

50+
### For Utility Scripts
51+
52+
The plugin includes utility scripts for validation and testing. These require:
53+
54+
| Tool | Version | Purpose |
55+
|------|---------|---------|
56+
| bash | 3.2+ | Shell scripting (macOS default works) |
57+
| jq | 1.6+ | JSON parsing and validation |
58+
| grep | - | Pattern matching (with `-E` support) |
59+
| sed | - | Stream editing (GNU or BSD) |
60+
61+
**Check your environment:**
62+
63+
```bash
64+
bash --version | head -1
65+
jq --version
66+
grep --version 2>&1 | head -1
67+
```
68+
69+
> **Note**: `jq` may need to be installed. macOS: `brew install jq`, Linux: `apt install jq`
70+
4971
## Installation
5072

5173
Add this marketplace and install the plugin:

plugins/plugin-dev/skills/hook-development/SKILL.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -695,6 +695,8 @@ Working examples in `examples/`:
695695

696696
### Utility Scripts
697697

698+
> **Prerequisites**: These scripts require `jq` for JSON validation. See the [main README](../../../../README.md#for-utility-scripts) for setup.
699+
698700
Development tools in `scripts/`:
699701

700702
- **`validate-hook-schema.sh`** - Validate hooks.json structure and syntax

0 commit comments

Comments
 (0)