Skip to content

Commit 52da7fb

Browse files
authored
Merge pull request #24 from Jamkris/feat/sync-scripts-and-audit
feat: migrate and document scripts including harness-audit
2 parents 47e0959 + 08a554d commit 52da7fb

3 files changed

Lines changed: 565 additions & 0 deletions

File tree

scripts/README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Scripts Reference
2+
3+
**Language:** English | [한국어](ko-KR/README.md)
4+
5+
This directory contains utility scripts for maintaining the Everything Gemini Code repository.
6+
7+
> **Note:**
8+
> Many legacy installation scripts (`ecc.js`, `claw.js`, `install-plan.js`, etc.) from the previous Claude Code era have been completely removed. Gemini CLI handles environments, context, and installations natively through its Extension architecture (`gemini extensions`).
9+
10+
---
11+
12+
## Available Scripts
13+
14+
### Governance & Quality
15+
16+
| Script | Description |
17+
|--------|-------------|
18+
| `harness-audit.js` | Audits the repository against core Gemini CLI harness rules. Checks for the presence of required context optimization documents, eval coverage, required hooks, and security guards. <br><br> **Usage:** `node scripts/harness-audit.js --scope repo` |
19+
20+
### Documentation Generation
21+
22+
| Script | Description |
23+
|--------|-------------|
24+
| `generate-docs.js` | Scans the `skills/` directory and updates the main `README.md` to list available skills and commands automatically. <br><br> **Usage:** `node scripts/generate-docs.js` |
25+
| `generate-command-docs.js` | Scans `.toml` files in the `commands/` directory and creates or updates a Markdown reference index. <br><br> **Usage:** `node scripts/generate-command-docs.js` |
26+
27+
### Migrations & Formatting
28+
29+
| Script | Description |
30+
|--------|-------------|
31+
| `migrate-commands.js` | A migration tool to assist converting legacy `.md` commands into `.toml` commands required by Gemini CLI. <br><br> **Usage:** `node scripts/migrate-commands.js <source-dir> <dest-dir>` |
32+
| `setup-package-manager.js` | Ensures that the correct package manager (e.g., `npm`) and engines are used for the repository to maintain lockfile stability. <br><br> **Usage:** `node scripts/setup-package-manager.js` |
33+
| `skill-create-output.js` | Validates and formats LLM outputs when auto-generating new `SKILL.md` contents from git diffs. |
34+
35+
---
36+
37+
## Contributing a Script
38+
39+
If you add a new script to this directory:
40+
1. Ensure it does not attempt to duplicate Gemini CLI features (like replacing file states or creating custom REPLs).
41+
2. It must be a standalone Node.js script.
42+
3. Update this `README.md` and the Korean counterpart `ko-KR/README.md` with its usage instructions.

0 commit comments

Comments
 (0)