Skip to content

Commit 00c61fd

Browse files
committed
docs: use installed ghcrawl binary in skill docs
1 parent 8ca64c4 commit 00c61fd

File tree

2 files changed

+8
-39
lines changed

2 files changed

+8
-39
lines changed

skills/ghcrawl/SKILL.md

Lines changed: 3 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
name: ghcrawl
33
description: "Use the local ghcrawl CLI to inspect duplicate clusters and issue/PR summaries from the existing ghcrawl dataset, and refresh one repo only when the user explicitly asks. Use when a user wants to triage related issues or PRs, inspect semantic clusters, or run ghcrawl's staged refresh pipeline."
4-
allowed-tools: Bash(ghcrawl:*), Bash(pnpm:*), Read(*)
4+
allowed-tools: Bash(ghcrawl:*), Read(*)
55
---
66

77
# ghcrawl
@@ -31,13 +31,9 @@ Also never run `close-thread` or `close-cluster` unless the user explicitly asks
3131

3232
## Command preference
3333

34-
Prefer the installed `ghcrawl` bin.
34+
Use the installed `ghcrawl` bin directly.
3535

36-
If `ghcrawl` is not on `PATH`, use:
37-
38-
```bash
39-
npx ghcrawl cli ...
40-
```
36+
If `ghcrawl` is not on `PATH`, stop and tell the user the local `ghcrawl` binary is unavailable. Do not fall back to repo-local wrappers. If the user is actively maintaining `ghcrawl` itself and explicitly wants source-tree commands, use the maintainer workflow in `CONTRIBUTING.md`.
4137

4238
Do not start by running `ghcrawl --help` or `<subcommand> --help`. The documented command surface in this skill and [references/protocol.md](references/protocol.md) is the default source of truth. Only use help output when the user explicitly asks about CLI syntax or you are actively maintaining ghcrawl itself.
4339

@@ -95,12 +91,6 @@ Run:
9591
ghcrawl doctor --json
9692
```
9793

98-
If the bin is unavailable, fall back to:
99-
100-
```bash
101-
pnpm --filter ghcrawl cli doctor --json
102-
```
103-
10494
Only do this when:
10595

10696
- the user explicitly wants an API-backed operation such as `refresh`, `sync`, `embed`, or `cluster`
@@ -115,12 +105,6 @@ If `doctor` is unhealthy but the user asked only for read-only inspection, say t
115105

116106
### 3. If the CLI is unavailable or misbehaving
117107

118-
Use one supported fallback path before giving up:
119-
120-
```bash
121-
pnpm --filter ghcrawl cli ...
122-
```
123-
124108
If a documented `ghcrawl` command still fails, hangs, or returns unusable output through the supported CLI path, stop and report that to the user. Do not inspect tables, schema, or rows with `sqlite3`, `pragma`, or ad hoc SQL.
125109

126110
### 4. Refresh local data only when explicitly requested

skills/ghcrawl/references/protocol.md

Lines changed: 5 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -167,26 +167,11 @@ Useful for semantic or keyword follow-up.
167167

168168
Useful for inspecting nearest semantic matches for one thread.
169169

170-
## Fallback invocation
171-
172-
If `ghcrawl` is not installed globally:
173-
174-
```bash
175-
pnpm --filter ghcrawl cli doctor --json
176-
pnpm --filter ghcrawl cli threads owner/repo --numbers 12345
177-
pnpm --filter ghcrawl cli threads owner/repo --numbers 42,43,44
178-
pnpm --filter ghcrawl cli threads owner/repo --numbers 42,43,44 --include-closed
179-
pnpm --filter ghcrawl cli author owner/repo --login lqquan
180-
pnpm --filter ghcrawl cli refresh owner/repo
181-
pnpm --filter ghcrawl cli clusters owner/repo --min-size 10 --limit 20 --sort recent
182-
pnpm --filter ghcrawl cli clusters owner/repo --min-size 10 --limit 20 --sort recent --include-closed
183-
pnpm --filter ghcrawl cli cluster-detail owner/repo --id 123 --member-limit 20 --body-chars 280
184-
pnpm --filter ghcrawl cli cluster-detail owner/repo --id 123 --member-limit 20 --body-chars 280 --include-closed
185-
pnpm --filter ghcrawl cli close-thread owner/repo --number 42
186-
pnpm --filter ghcrawl cli close-cluster owner/repo --id 123
187-
```
188-
189-
If the supported CLI path still fails, hangs, or returns unusable output, stop and tell the user there is a ghcrawl CLI problem. Do not fall back to direct SQLite inspection.
170+
## CLI availability
171+
172+
Use the installed `ghcrawl` binary directly.
173+
174+
If `ghcrawl` is missing on `PATH`, stop and tell the user the local `ghcrawl` binary is unavailable. Do not fall back to project-local wrappers or direct SQLite inspection. If the user is actively maintaining `ghcrawl` itself and explicitly wants source-tree commands, use the maintainer workflow documented in `CONTRIBUTING.md`.
190175

191176
## Suggested analysis flow
192177

0 commit comments

Comments
 (0)