Skip to content

Commit 4db071a

Browse files
committed
docs: focus readme on refresh workflow
1 parent 5de50d2 commit 4db071a

File tree

3 files changed

+37
-14
lines changed

3 files changed

+37
-14
lines changed

README.md

Lines changed: 37 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -44,30 +44,37 @@ ghcrawl tui owner/repo
4444
- save plaintext keys in `~/.config/ghcrawl/config.json`
4545
- or guide you through a 1Password CLI (`op`) setup that keeps keys out of the config file
4646

47+
`ghcrawl refresh owner/repo` is the main pipeline command. It pulls the latest open GitHub issues and pull requests, refreshes embeddings for changed items, and rebuilds the clusters you browse in the TUI.
48+
4749
## Typical Commands
4850

4951
```bash
5052
ghcrawl doctor
51-
ghcrawl sync owner/repo --since 7d
5253
ghcrawl refresh owner/repo
53-
ghcrawl embed owner/repo
54-
ghcrawl cluster owner/repo
55-
ghcrawl clusters owner/repo --min-size 10 --limit 20
56-
ghcrawl cluster-detail owner/repo --id 123
57-
ghcrawl search owner/repo --query "download stalls"
5854
ghcrawl tui owner/repo
59-
ghcrawl serve
6055
```
6156

62-
### Embed Command Example
57+
### Refresh Command Example
6358

6459
```bash
65-
ghcrawl embed owner/repo
60+
ghcrawl refresh owner/repo
6661
```
6762

68-
<video src="./docs/images/ghcrawl-embed.mp4" controls muted playsinline></video>
63+
![ghcrawl refresh demo](./docs/images/ghcrawl-refresh-demo.gif)
64+
65+
## Controlling The Refresh Flow More Intentionally
66+
67+
Most users should run `ghcrawl refresh owner/repo` and let it do the full pipeline in the right order.
68+
69+
If you need tighter control, you can run the three stages yourself:
70+
71+
```bash
72+
ghcrawl sync owner/repo # pull the latest open issues and pull requests from GitHub
73+
ghcrawl embed owner/repo # generate or refresh OpenAI embeddings for changed items
74+
ghcrawl cluster owner/repo # rebuild local related-work clusters from the current vectors
75+
```
6976

70-
If your Markdown renderer does not show the video inline, open [ghcrawl-embed.mp4](./docs/images/ghcrawl-embed.mp4) directly.
77+
Run them in that order. `refresh` is just the safe convenience command that performs the same sequence for you.
7178

7279
## Init And Doctor
7380

@@ -107,7 +114,12 @@ GitHub token guidance:
107114

108115
### 1Password CLI Example
109116

110-
If you choose 1Password CLI mode, init shows a `~/.zshrc` helper like this:
117+
If you choose 1Password CLI mode, create a 1Password Secure Note with concealed fields named exactly:
118+
119+
- `GITHUB_TOKEN`
120+
- `OPENAI_API_KEY`
121+
122+
Then add this wrapper to `~/.zshrc`:
111123

112124
```bash
113125
ghcrawl-op() {
@@ -121,8 +133,19 @@ Then use:
121133

122134
```bash
123135
ghcrawl-op doctor
124-
ghcrawl-op tui
125-
ghcrawl-op sync owner/repo
136+
ghcrawl-op refresh owner/repo
137+
ghcrawl-op tui owner/repo
138+
```
139+
140+
## Using The CLI To Extract JSON Data
141+
142+
These commands are intended more for scripts, bots, and agent integrations than for normal day-to-day terminal browsing:
143+
144+
```bash
145+
ghcrawl cluster owner/repo
146+
ghcrawl clusters owner/repo --min-size 10 --limit 20
147+
ghcrawl cluster-detail owner/repo --id 123
148+
ghcrawl search owner/repo --query "download stalls"
126149
```
127150

128151
## Cost To Operate

docs/images/ghcrawl-embed.mp4

-3.67 MB
Binary file not shown.
13.6 MB
Loading

0 commit comments

Comments
 (0)