@brianlovin/hn-cli 0.4.1 → 0.4.3

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 (3) hide show
  1. package/README.md +57 -40
  2. package/dist/cli.js +24 -24
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -2,6 +2,8 @@
2
2
 
3
3
  A terminal UI for browsing Hacker News, modeled after the HN reader on my [personal website](https://brianlovin.com/hn).
4
4
 
5
+ <img width="2634" height="1814" alt="Screen Shot 2026-01-26 at 08 34 02@2x" src="https://github.com/user-attachments/assets/1db5a3e2-138e-45da-9cbd-64b3515c7e0c" />
6
+
5
7
  ## Installation
6
8
 
7
9
  ```bash
@@ -41,9 +43,24 @@ bun run start
41
43
  - Click on stories in the sidebar to select them
42
44
  - Click story title/URL to open in browser
43
45
 
44
- ### AI Chat
46
+ ### AI Features
47
+
48
+ #### TL;DR Summaries
49
+
50
+ Press `t` on any story to generate an AI-powered summary. The AI reads the article and all comments, then provides:
51
+
52
+ - A concise summary of the article
53
+ - Key takeaways from the discussion
54
+
55
+ Summaries are cached locally, so you can revisit them without regenerating.
56
+
57
+ <img width="2634" height="1814" alt="Screen Shot 2026-01-26 at 08 35 01@2x" src="https://github.com/user-attachments/assets/69ad54eb-3b6d-4ae9-bfa3-71aa75a2c414" />
58
+
59
+ #### Chat
60
+
61
+ Press `c` to start a conversation with an AI about the story. The AI has full context of the article and all comments, so you can ask follow-up questions, get clarification, or dive deeper into specific topics.
45
62
 
46
- Press `c` on any story to start a conversation with an AI about the story and its comments. The AI has full context of the story content and all comments.
63
+ <img width="2634" height="1814" alt="Screen Shot 2026-01-26 at 08 34 20@2x" src="https://github.com/user-attachments/assets/7c5e118c-325b-45cd-872c-bca8eea67a03" />
47
64
 
48
65
  #### Bring Your Own API Key
49
66
 
@@ -61,7 +78,44 @@ export OPENAI_API_KEY=sk-...
61
78
 
62
79
  **Option 2: In-app setup**
63
80
 
64
- Press `c` to start a chat, and you'll be guided through the setup. Your key is stored locally at `~/.config/hn-cli/config.json`.
81
+ Press `s` to open settings and you'll be guided through the setup. Your key is stored locally at `~/.config/hn-cli/config.json`.
82
+
83
+ ## Settings
84
+
85
+ Press `s` at any time to open the settings panel.
86
+
87
+ <img width="2634" height="1814" alt="Screen Shot 2026-01-26 at 08 34 34@2x" src="https://github.com/user-attachments/assets/9446753c-2b94-4fa4-9457-5706a461f36e" />
88
+
89
+ ### AI Provider
90
+
91
+ - Switch between Anthropic and OpenAI
92
+ - Change the model (Claude Opus/Sonnet/Haiku, GPT-5 Nano/GPT-5 Mini/GPT-5.2)
93
+ - Add or clear API keys
94
+
95
+ ### Story Filtering
96
+
97
+ These settings control which stories appear in your feed:
98
+
99
+ | Setting | Default | Description |
100
+ | ------------ | ------- | --------------------------------------- |
101
+ | Max Stories | 24 | Maximum number of stories to display |
102
+ | Time Window | 24h | Only show stories from the last N hours |
103
+ | Min Points | 50 | Minimum points required |
104
+ | Min Comments | 20 | Minimum comments required |
105
+
106
+ ### Comment Display
107
+
108
+ | Setting | Default | Description |
109
+ | -------------- | ------- | ------------------------------------------- |
110
+ | Root Comments | 12 | Maximum root-level comments shown per story |
111
+ | Child Comments | 8 | Maximum replies shown per comment |
112
+ | Nesting Depth | 3 | Maximum levels of nested replies |
113
+
114
+ Settings are stored locally at `~/.config/hn-cli/config.json`.
115
+
116
+ ## Design decisions
117
+
118
+ The default settings match my HN reader on my [personal website](https://brianlovin.com/hn). I made these choices so that it's easier for me to keep up with the most interesting stories throughout the day without getting sucked too deep into long comment threads or the flood of new submissions.
65
119
 
66
120
  ---
67
121
 
@@ -115,43 +169,6 @@ bun run debug highlighted-comment # Test comment highlighting
115
169
  - `src/types.ts` - TypeScript types for HN data structures
116
170
  - `src/test/` - Test suite
117
171
 
118
- ## Settings
119
-
120
- Press `s` at any time to open the settings panel. Use `j`/`k` to navigate, `←`/`→` or `Enter` to adjust values, and `r` to reset all settings to defaults.
121
-
122
- ### AI Provider
123
-
124
- - Switch between Anthropic and OpenAI
125
- - Change the model (Claude Sonnet/Haiku, GPT-4o/4o-mini)
126
- - Add or clear API keys
127
-
128
- ### Story Filtering
129
-
130
- These settings control which stories appear in your feed:
131
-
132
- | Setting | Default | Description |
133
- | ------------ | ------- | ------------------------------------------ |
134
- | Max Stories | 24 | Maximum number of stories to display |
135
- | Time Window | 24h | Only show stories from the last N hours |
136
- | Min Points | 50 | Minimum upvotes required (OR min comments) |
137
- | Min Comments | 20 | Minimum comments required (OR min points) |
138
-
139
- ### Comment Display
140
-
141
- | Setting | Default | Description |
142
- | -------------- | ------- | ------------------------------------------- |
143
- | Root Comments | 12 | Maximum root-level comments shown per story |
144
- | Child Comments | 8 | Maximum replies shown per comment |
145
- | Nesting Depth | 3 | Maximum levels of nested replies |
146
-
147
- Settings are stored locally at `~/.config/hn-cli/config.json`.
148
-
149
- ## Design decisions
150
-
151
- The default settings match my HN reader on my [personal website](https://brianlovin.com/hn). I made these choices so that it's easier for me to keep up with the most interesting stories throughout the day without getting sucked too deep into long comment threads or the flood of new submissions.
152
-
153
- All defaults are now customizable via the settings panel (`s`).
154
-
155
172
  ## Telemetry
156
173
 
157
174
  This CLI collects anonymous usage data to help understand how people use it and what features to improve. No personal information or content is ever collected.