geethob 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +147 -0
- package/dist/cli.js +376 -0
- package/dist/geethob +0 -0
- package/package.json +58 -0
- package/skill/SKILL.md +85 -0
- package/skill/install.sh +18 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Hemant Bangar
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,147 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="assets/logo.svg" alt="geethob logo" width="160" height="160" />
|
|
3
|
+
</p>
|
|
4
|
+
|
|
5
|
+
<h1 align="center">geethob</h1>
|
|
6
|
+
|
|
7
|
+
<p align="center">Turn git history into prose narrative.</p>
|
|
8
|
+
|
|
9
|
+
AI now writes code faster than humans can review it. A 2,000-line AI-generated PR is hard to read at the diff grain — but the value is at the *story* grain: what was attempted, what changed mid-flight, what shipped. `geethob` reads a repository and produces prose someone would actually forward.
|
|
10
|
+
|
|
11
|
+
Two modes in v0.1:
|
|
12
|
+
|
|
13
|
+
- **`geethob story <repo>`** — narrate the history of a feature, module, or the whole repo.
|
|
14
|
+
- **`geethob digest --since 7d`** — narrate a developer's recent work, formatted to paste cleanly into Slack or a PR comment.
|
|
15
|
+
|
|
16
|
+
Local-only. Bring your own model key. No server. Same binary works as a CLI for humans and a skill for AI harnesses (Claude Code today; Hermes, OpenClaw, Cursor, MCP servers as adapters land).
|
|
17
|
+
|
|
18
|
+
## Install
|
|
19
|
+
|
|
20
|
+
### Single-binary (no runtime needed)
|
|
21
|
+
|
|
22
|
+
Download the binary for your platform from [the latest release](https://github.com/hemant1996/geethob/releases/latest), drop it on your `$PATH`, and `chmod +x`:
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
# macOS arm64
|
|
26
|
+
curl -L https://github.com/hemant1996/geethob/releases/latest/download/geethob-darwin-arm64 -o /usr/local/bin/geethob
|
|
27
|
+
chmod +x /usr/local/bin/geethob
|
|
28
|
+
|
|
29
|
+
# macOS x64
|
|
30
|
+
curl -L https://github.com/hemant1996/geethob/releases/latest/download/geethob-darwin-x64 -o /usr/local/bin/geethob
|
|
31
|
+
chmod +x /usr/local/bin/geethob
|
|
32
|
+
|
|
33
|
+
# Linux x64
|
|
34
|
+
curl -L https://github.com/hemant1996/geethob/releases/latest/download/geethob-linux-x64 -o /usr/local/bin/geethob
|
|
35
|
+
chmod +x /usr/local/bin/geethob
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### From npm
|
|
39
|
+
|
|
40
|
+
Requires Node ≥20 or Bun ≥1.1.
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
npm install -g geethob
|
|
44
|
+
# or
|
|
45
|
+
bun add -g geethob
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## Configure
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
export ANTHROPIC_API_KEY=sk-ant-…
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
Or persist it on disk (file mode 0600):
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
geethob configure
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
For private GitHub repos, geethob also reads `gh auth status` (the GitHub CLI) or `GH_TOKEN` from the environment.
|
|
61
|
+
|
|
62
|
+
## Use
|
|
63
|
+
|
|
64
|
+
```bash
|
|
65
|
+
# Narrate the history of a feature
|
|
66
|
+
geethob story . --path src/auth --since 30d
|
|
67
|
+
|
|
68
|
+
# Narrate a public repo
|
|
69
|
+
geethob story bun-sh/bun --max-commits 50
|
|
70
|
+
|
|
71
|
+
# Your week, as a story
|
|
72
|
+
geethob digest --since 7d
|
|
73
|
+
|
|
74
|
+
# Someone else's public activity
|
|
75
|
+
geethob digest --author tj --since 14d
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
`--max-commits` defaults to 200. If the prompt would overflow Claude Sonnet's context window, geethob sheds the oldest commits to fit and prints a warning.
|
|
79
|
+
|
|
80
|
+
## Use from your AI harness
|
|
81
|
+
|
|
82
|
+
geethob ships as a skill that any compatible AI harness can invoke.
|
|
83
|
+
|
|
84
|
+
### Claude Code — plugin install (recommended)
|
|
85
|
+
|
|
86
|
+
Inside Claude Code, run:
|
|
87
|
+
|
|
88
|
+
```
|
|
89
|
+
/plugin marketplace add hemant1996/geethob
|
|
90
|
+
/plugin install geethob@hemant1996
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
The plugin bundles the `narrate` skill, which Claude Code's Skill tool will invoke automatically whenever you ask story-grained questions about a repo's history. You can also invoke it explicitly via `/geethob:narrate`.
|
|
94
|
+
|
|
95
|
+
### Claude Code — manual install (legacy)
|
|
96
|
+
|
|
97
|
+
If you prefer a shell-based install:
|
|
98
|
+
|
|
99
|
+
```bash
|
|
100
|
+
./skill/install.sh
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
This drops `SKILL.md` into `~/.claude/skills/geethob/`. Restart Claude Code (or reload skills) and the `geethob` skill is invokable from the Skill tool.
|
|
104
|
+
|
|
105
|
+
### Hermes / OpenClaw / Cursor
|
|
106
|
+
|
|
107
|
+
Manual until v0.2 ships adapters. Each harness has a skills directory; copy `skill/SKILL.md` into it and adjust the invocation paths to point at the `geethob` binary on your `$PATH`. PRs welcome with one-line install snippets for any harness you've tested.
|
|
108
|
+
|
|
109
|
+
### MCP server (v0.2)
|
|
110
|
+
|
|
111
|
+
`geethob serve` will expose `story` and `digest` as MCP tools so any MCP-compatible host can invoke them without shelling out. Not in v0.1.
|
|
112
|
+
|
|
113
|
+
## Exit codes
|
|
114
|
+
|
|
115
|
+
| Code | Meaning |
|
|
116
|
+
| --- | --- |
|
|
117
|
+
| 0 | Success (including empty commit range — that's not an error) |
|
|
118
|
+
| 1 | Usage error (bad flags) |
|
|
119
|
+
| 2 | `git` not on `$PATH` or scope is not a git repository |
|
|
120
|
+
| 3 | Missing or invalid Anthropic API key |
|
|
121
|
+
| 4 | Model API error (after one retry on 5xx) |
|
|
122
|
+
| 5 | GitHub API auth required, rate-limited, or repository not found |
|
|
123
|
+
|
|
124
|
+
## Build from source
|
|
125
|
+
|
|
126
|
+
```bash
|
|
127
|
+
git clone https://github.com/hemant1996/geethob && cd geethob
|
|
128
|
+
bun install
|
|
129
|
+
bun run dev story .
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
To produce a single binary:
|
|
133
|
+
|
|
134
|
+
```bash
|
|
135
|
+
bun run build:bin # current platform
|
|
136
|
+
bun run build:bin:darwin-arm64
|
|
137
|
+
bun run build:bin:darwin-x64
|
|
138
|
+
bun run build:bin:linux-x64
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
## Design
|
|
142
|
+
|
|
143
|
+
See [DESIGN.md](./DESIGN.md) for the full scope, premises, and rationale behind v0.1. The short version: v1 ships two modes (`story`, `digest`) because we want to validate the prose-quality thesis before building a structured two-pass engine. PR-review narrative, multi-provider, multi-format, named voices, and MCP server mode are all v0.2+.
|
|
144
|
+
|
|
145
|
+
## License
|
|
146
|
+
|
|
147
|
+
MIT.
|