gh-tldr 1.0.8 โ†’ 1.0.9

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.
Files changed (2) hide show
  1. package/README.md +74 -39
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,6 +1,35 @@
1
+ <p align="center">
2
+ <img src="https://img.shields.io/npm/v/gh-tldr.svg" alt="npm version">
3
+ <img src="https://img.shields.io/npm/l/gh-tldr.svg" alt="license">
4
+ <img src="https://img.shields.io/node/v/gh-tldr.svg" alt="node version">
5
+ </p>
6
+
1
7
  # gh-tldr
2
8
 
3
- Generate a TL;DR summary of your GitHub activity using Claude.
9
+ **AI-powered TL;DR of your GitHub activity**
10
+
11
+ Stop manually tracking what you did this week. `gh-tldr` fetches your GitHub activity and uses Claude AI to generate a human-readable summaryโ€”perfect for standups, status updates, or weekly reports.
12
+
13
+ <p align="center">
14
+ <img src="assets/demo.gif" alt="gh-tldr demo" width="700">
15
+ </p>
16
+
17
+ ## Quick Start
18
+
19
+ ```bash
20
+ npx gh-tldr
21
+ ```
22
+
23
+ That's it. Follow the prompts.
24
+
25
+ ## Features
26
+
27
+ - ๐Ÿ“Š Summarizes PRs, reviews, commits, and issues
28
+ - ๐Ÿค– Powered by Claude AI for natural language summaries
29
+ - ๐Ÿ”„ Interactive or scripted mode
30
+ - ๐Ÿ“ Multiple output formats (plain text, markdown, slack)
31
+ - ๐Ÿ”’ Private repository support
32
+ - ๐ŸŒ English and German output
4
33
 
5
34
  ## Prerequisites
6
35
 
@@ -8,35 +37,37 @@ Generate a TL;DR summary of your GitHub activity using Claude.
8
37
  - [GitHub CLI](https://cli.github.com/) (`gh`) - authenticated
9
38
  - [Claude Code](https://docs.anthropic.com/en/docs/claude-code) (`claude`)
10
39
 
40
+ <details>
41
+ <summary>macOS quick setup</summary>
42
+
11
43
  ```bash
12
- # macOS
13
44
  brew install gh node
14
-
15
- # Authenticate gh
16
45
  gh auth login
17
46
  ```
18
47
 
48
+ </details>
49
+
19
50
  ## Installation
20
51
 
52
+ The easiest way is `npx gh-tldr` (no install needed).
53
+
54
+ <details>
55
+ <summary>Alternative: Install globally</summary>
56
+
21
57
  ```bash
22
- # Clone and install
23
58
  git clone https://github.com/yungweng/gh-tldr.git
24
59
  cd gh-tldr
25
60
  pnpm install
26
61
  pnpm build
27
-
28
- # Link globally
29
62
  pnpm link --global
30
63
  ```
31
64
 
32
- Or via npx:
33
- ```bash
34
- npx gh-tldr
35
- ```
65
+ </details>
36
66
 
37
- ### Note for Aikido Safe-Chain Users
67
+ <details>
68
+ <summary>Note for Aikido Safe-Chain users</summary>
38
69
 
39
- If you use [Aikido Safe-Chain](https://github.com/AikidoSec/safe-chain), you may need to bypass it when running via npx:
70
+ If you use [Aikido Safe-Chain](https://github.com/AikidoSec/safe-chain), you may need to bypass it:
40
71
 
41
72
  ```bash
42
73
  # Bash/Zsh
@@ -46,7 +77,7 @@ If you use [Aikido Safe-Chain](https://github.com/AikidoSec/safe-chain), you may
46
77
  command npx gh-tldr
47
78
  ```
48
79
 
49
- Or add an alias to your shell config:
80
+ Or add an alias:
50
81
  ```bash
51
82
  # ~/.bashrc or ~/.zshrc
52
83
  alias gh-tldr='\npx gh-tldr'
@@ -55,12 +86,12 @@ alias gh-tldr='\npx gh-tldr'
55
86
  alias gh-tldr='command npx gh-tldr'
56
87
  ```
57
88
 
89
+ </details>
90
+
58
91
  ## Usage
59
92
 
60
93
  ### Interactive Mode
61
94
 
62
- Run without arguments for guided prompts:
63
-
64
95
  ```bash
65
96
  gh-tldr
66
97
  ```
@@ -76,25 +107,20 @@ gh-tldr
76
107
 
77
108
  ### Direct Mode
78
109
 
79
- Use flags for scripting:
80
-
81
110
  ```bash
82
- # Basic usage
83
- gh-tldr --days 7 --english
84
-
85
- # All options
86
111
  gh-tldr [username] [options]
87
-
88
- Options:
89
- -d, --days <n> Time period in days (default: 1)
90
- -e, --english Output in English (default: German)
91
- -f, --format <type> Output format: plain|markdown|slack (default: slack)
92
- -p, --public-only Exclude private repositories
93
- -m, --model <model> Claude model (e.g., haiku, sonnet, opus)
94
- -i, --interactive Force interactive mode
95
- -h, --help Show help
96
112
  ```
97
113
 
114
+ | Option | Description |
115
+ |--------|-------------|
116
+ | `-d, --days <n>` | Time period in days (default: 1) |
117
+ | `-e, --english` | Output in English (default: German) |
118
+ | `-f, --format <type>` | Output: `plain` \| `markdown` \| `slack` |
119
+ | `-p, --public-only` | Exclude private repositories |
120
+ | `-m, --model <model>` | Claude model (e.g., haiku, sonnet, opus) |
121
+ | `-i, --interactive` | Force interactive mode |
122
+ | `-h, --help` | Show help |
123
+
98
124
  ### Examples
99
125
 
100
126
  ```bash
@@ -111,7 +137,7 @@ gh-tldr --model haiku
111
137
  gh-tldr --days 30 --format markdown
112
138
  ```
113
139
 
114
- ## Output
140
+ ## Example Output
115
141
 
116
142
  ```
117
143
  tl;dr 28.12.2025
@@ -132,15 +158,24 @@ Did several code reviews for the team, including the new API endpoint.
132
158
  ## Development
133
159
 
134
160
  ```bash
135
- # Run in dev mode
136
- pnpm dev
161
+ pnpm dev # Run in dev mode
162
+ pnpm build # Build
163
+ pnpm typecheck # Type check
164
+ ```
137
165
 
138
- # Build
139
- pnpm build
166
+ ## Contributing
140
167
 
141
- # Type check
142
- pnpm typecheck
143
- ```
168
+ Issues and PRs welcome! See [open issues](https://github.com/yungweng/gh-tldr/issues).
169
+
170
+ ## Links
171
+
172
+ - [Repository](https://github.com/yungweng/gh-tldr)
173
+ - [Issues](https://github.com/yungweng/gh-tldr/issues)
174
+ - [npm](https://www.npmjs.com/package/gh-tldr)
175
+
176
+ ## Author
177
+
178
+ Maintained by [@yungweng](https://github.com/yungweng)
144
179
 
145
180
  ## License
146
181
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "gh-tldr",
3
- "version": "1.0.8",
3
+ "version": "1.0.9",
4
4
  "description": "Generate a TL;DR summary of your GitHub activity",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",