@releasehub/cli 1.0.0 → 1.0.1
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/README.md +184 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,184 @@
|
|
|
1
|
+
# ReleaseHub
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@releasehub/cli)
|
|
4
|
+
[](https://www.npmjs.com/package/@releasehub/cli)
|
|
5
|
+
[](LICENSE)
|
|
6
|
+
[](https://nodejs.org)
|
|
7
|
+
|
|
8
|
+
> AI-powered release notes from your terminal.
|
|
9
|
+
|
|
10
|
+
ReleaseHub reads your merged pull requests, filters the noise, rewrites technical titles into plain language, and outputs GitHub release notes, a changelog entry, or a Slack message — in one command.
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
npx @releasehub/cli generate --from v2.3.0 --to v2.4.0
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
## Install
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
npm install -g @releasehub/cli
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Requires Node.js 18 or later.
|
|
25
|
+
|
|
26
|
+
---
|
|
27
|
+
|
|
28
|
+
## Quick start
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
# 1. Connect your GitHub account
|
|
32
|
+
releasehub auth login
|
|
33
|
+
|
|
34
|
+
# 2. Add your AI key (Anthropic or OpenAI)
|
|
35
|
+
releasehub ai add-key
|
|
36
|
+
|
|
37
|
+
# 3. Generate release notes
|
|
38
|
+
releasehub generate --from v2.3.0 --to v2.4.0
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
## Output formats
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
# GitHub Release markdown (default)
|
|
47
|
+
releasehub generate --from v2.3.0 --to v2.4.0 --format github-release
|
|
48
|
+
|
|
49
|
+
# Keep a Changelog format
|
|
50
|
+
releasehub generate --from v2.3.0 --to v2.4.0 --format changelog
|
|
51
|
+
|
|
52
|
+
# Compact Slack message
|
|
53
|
+
releasehub generate --from v2.3.0 --to v2.4.0 --format slack
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
**Example output** (`--format github-release`):
|
|
57
|
+
|
|
58
|
+
```markdown
|
|
59
|
+
## v2.4.0
|
|
60
|
+
|
|
61
|
+
This release includes 2 new features, 3 improvements and 1 bug fix.
|
|
62
|
+
|
|
63
|
+
### ✨ New Features
|
|
64
|
+
|
|
65
|
+
- You can now export reports as CSV directly from the dashboard
|
|
66
|
+
- Added keyboard shortcuts for the most common actions
|
|
67
|
+
|
|
68
|
+
### 🔧 Improvements
|
|
69
|
+
|
|
70
|
+
- Search results now load noticeably faster
|
|
71
|
+
- Dark mode contrast improved across all pages
|
|
72
|
+
- Notification preferences are easier to find in settings
|
|
73
|
+
|
|
74
|
+
### 🐛 Bug Fixes
|
|
75
|
+
|
|
76
|
+
- Fixed an issue where file uploads would silently fail on slow connections
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
---
|
|
80
|
+
|
|
81
|
+
## Write to a file
|
|
82
|
+
|
|
83
|
+
```bash
|
|
84
|
+
releasehub generate --from v2.3.0 --to v2.4.0 --output RELEASE.md
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
## Publish as a GitHub Release
|
|
88
|
+
|
|
89
|
+
```bash
|
|
90
|
+
releasehub generate --from v2.3.0 --to v2.4.0 --publish
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
## Use in CI (GitHub Actions)
|
|
94
|
+
|
|
95
|
+
```yaml
|
|
96
|
+
- name: Generate release notes
|
|
97
|
+
env:
|
|
98
|
+
RELEASEHUB_GITHUB_TOKEN: ${{ secrets.RELEASEHUB_GITHUB_TOKEN }}
|
|
99
|
+
RELEASEHUB_ANTHROPIC_KEY: ${{ secrets.RELEASEHUB_ANTHROPIC_KEY }}
|
|
100
|
+
run: |
|
|
101
|
+
npx @releasehub/cli generate \
|
|
102
|
+
--from ${{ github.event.release.target_commitish }} \
|
|
103
|
+
--to ${{ github.ref_name }} \
|
|
104
|
+
--format github-release \
|
|
105
|
+
--quiet \
|
|
106
|
+
--output release-notes.md
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
---
|
|
110
|
+
|
|
111
|
+
## Commands
|
|
112
|
+
|
|
113
|
+
| Command | Description |
|
|
114
|
+
|---|---|
|
|
115
|
+
| `releasehub auth login` | Connect your GitHub account via OAuth |
|
|
116
|
+
| `releasehub auth logout` | Disconnect and remove saved token |
|
|
117
|
+
| `releasehub ai add-key` | Add an Anthropic or OpenAI key |
|
|
118
|
+
| `releasehub ai switch` | Switch active AI provider |
|
|
119
|
+
| `releasehub ai status` | Show provider status and validate keys |
|
|
120
|
+
| `releasehub generate` | Generate release notes from merged PRs |
|
|
121
|
+
|
|
122
|
+
### `generate` flags
|
|
123
|
+
|
|
124
|
+
| Flag | Default | Description |
|
|
125
|
+
|---|---|---|
|
|
126
|
+
| `--from <tag>` | required | Start tag |
|
|
127
|
+
| `--to <tag>` | required | End tag |
|
|
128
|
+
| `--repo <owner/name>` | auto-detect | Repository (defaults to git remote) |
|
|
129
|
+
| `--format <format>` | `github-release` | `github-release` \| `changelog` \| `slack` |
|
|
130
|
+
| `--output <file>` | stdout | Write output to a file |
|
|
131
|
+
| `--publish` | — | Publish as a GitHub Release |
|
|
132
|
+
| `--quiet` | — | Suppress progress output (CI mode) |
|
|
133
|
+
|
|
134
|
+
---
|
|
135
|
+
|
|
136
|
+
## AI providers
|
|
137
|
+
|
|
138
|
+
| Provider | Model | Set key via |
|
|
139
|
+
|---|---|---|
|
|
140
|
+
| Anthropic | claude-sonnet-4-6 | `releasehub ai add-key` or `RELEASEHUB_ANTHROPIC_KEY` |
|
|
141
|
+
| OpenAI | gpt-4o | `releasehub ai add-key` or `RELEASEHUB_OPENAI_KEY` |
|
|
142
|
+
|
|
143
|
+
Anthropic is the default. Switch with `releasehub ai switch`.
|
|
144
|
+
|
|
145
|
+
---
|
|
146
|
+
|
|
147
|
+
## Environment variables
|
|
148
|
+
|
|
149
|
+
| Variable | Description |
|
|
150
|
+
|---|---|
|
|
151
|
+
| `RELEASEHUB_GITHUB_TOKEN` | GitHub personal access token (alternative to `auth login`) |
|
|
152
|
+
| `RELEASEHUB_ANTHROPIC_KEY` | Anthropic API key |
|
|
153
|
+
| `RELEASEHUB_OPENAI_KEY` | OpenAI API key |
|
|
154
|
+
|
|
155
|
+
---
|
|
156
|
+
|
|
157
|
+
## Repo structure
|
|
158
|
+
|
|
159
|
+
```
|
|
160
|
+
releasehub/
|
|
161
|
+
├── apps/
|
|
162
|
+
│ └── web/ # Landing page + docs (React + Vite)
|
|
163
|
+
├── packages/
|
|
164
|
+
│ └── cli/ # @releasehub/cli npm package
|
|
165
|
+
└── planning/ # Product docs, milestones, architecture
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
---
|
|
169
|
+
|
|
170
|
+
## Support
|
|
171
|
+
|
|
172
|
+
If ReleaseHub saves you time, consider buying me a coffee:
|
|
173
|
+
|
|
174
|
+
<a href="https://www.buymeacoffee.com/beratbozkurt0" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me a Coffee" style="height: 60px !important;width: 217px !important;" ></a>
|
|
175
|
+
|
|
176
|
+
---
|
|
177
|
+
|
|
178
|
+
## License
|
|
179
|
+
|
|
180
|
+
MIT — see [LICENSE](LICENSE).
|
|
181
|
+
|
|
182
|
+
---
|
|
183
|
+
|
|
184
|
+
Built by [@berat](https://twitter.com/beratbuilds)
|