docs: add gitcrawl agent skill
This commit is contained in:
parent
bed1da5471
commit
86f67bea8b
89
.agents/skills/gitcrawl/SKILL.md
Normal file
89
.agents/skills/gitcrawl/SKILL.md
Normal file
@ -0,0 +1,89 @@
|
||||
---
|
||||
name: gitcrawl
|
||||
description: Use for local GitHub issue/PR archive search, sync freshness, clusters, durable maintainer triage, gh-shim cache reads, and Gitcrawl repo/release work.
|
||||
---
|
||||
|
||||
# Gitcrawl
|
||||
|
||||
Use local archive data first for GitHub issue and pull request questions. Browse
|
||||
or hit live GitHub APIs only when the local archive is stale, missing the
|
||||
requested scope, or the user asks for current external context.
|
||||
|
||||
## Sources
|
||||
|
||||
- DB: `~/.config/gitcrawl/gitcrawl.db`
|
||||
- Config: `~/.config/gitcrawl/config.toml`
|
||||
- Cache: `~/.config/gitcrawl/cache`
|
||||
- Vectors: `~/.config/gitcrawl/vectors`
|
||||
- Repo: `~/GIT/_Perso/gitcrawl`
|
||||
- Preferred CLI: `gitcrawl`; fallback to `go run ./cmd/gitcrawl` from the repo if the installed binary is stale
|
||||
|
||||
## Freshness
|
||||
|
||||
For recent/current questions, check freshness before analysis:
|
||||
|
||||
```bash
|
||||
sqlite3 ~/.config/gitcrawl/gitcrawl.db \
|
||||
"select coalesce(max(finished_at), '') from sync_runs where status = 'success';"
|
||||
```
|
||||
|
||||
Routine refresh:
|
||||
|
||||
```bash
|
||||
gitcrawl doctor
|
||||
gitcrawl refresh owner/repo
|
||||
```
|
||||
|
||||
Targeted refresh:
|
||||
|
||||
```bash
|
||||
gitcrawl sync owner/repo --numbers 123,456 --with pr-details
|
||||
```
|
||||
|
||||
For agent-driven discovery, prefer bounded freshness:
|
||||
|
||||
```bash
|
||||
gitcrawl search issues "query" -R owner/repo --state open --sync-if-stale 5m --json number,title,url
|
||||
```
|
||||
|
||||
## Query Workflow
|
||||
|
||||
1. Resolve scope: owner/repo, issue/PR number, cluster id, keyword, label, author, state, or date range.
|
||||
2. Check freshness for recent/current requests.
|
||||
3. Use CLI for normal reads; use read-only SQL for precise counts/rankings.
|
||||
4. Report absolute date spans, repo names, issue/PR numbers, cluster ids, and known gaps.
|
||||
|
||||
Common commands:
|
||||
|
||||
```bash
|
||||
gitcrawl search issues "query" -R owner/repo --state open --json number,title,url
|
||||
gitcrawl clusters owner/repo --sort size --min-size 5
|
||||
gitcrawl cluster-detail owner/repo --id <id>
|
||||
gitcrawl gh pr view 123 -R owner/repo --json number,title,state,url
|
||||
```
|
||||
|
||||
When the installed CLI lacks a new feature, build or run from
|
||||
`~/GIT/_Perso/gitcrawl` before concluding the feature is missing.
|
||||
|
||||
## Maintainer Boundaries
|
||||
|
||||
`close-thread`, `close-cluster`, exclusions, and canonical-member choices are
|
||||
local maintainer overrides; they do not write back to GitHub. Set
|
||||
`GITCRAWL_GH_PATH` explicitly when using the gh shim so it cannot recurse into
|
||||
itself.
|
||||
|
||||
## Verification
|
||||
|
||||
For repo edits, prefer existing Go gates:
|
||||
|
||||
```bash
|
||||
GOWORK=off go test ./...
|
||||
```
|
||||
|
||||
Then run targeted CLI smoke for the touched surface, for example:
|
||||
|
||||
```bash
|
||||
gitcrawl doctor --json
|
||||
gitcrawl status --json
|
||||
gitcrawl search issues "test" -R openclaw/gitcrawl --state open --limit 5
|
||||
```
|
||||
Loading…
Reference in New Issue
Block a user