@buildinternet/releases 0.56.0 → 0.57.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.
Files changed (2) hide show
  1. package/README.md +14 -3
  2. package/package.json +6 -6
package/README.md CHANGED
@@ -10,7 +10,7 @@ The changelog & release-notes registry for developers and AI agents. A lean HTTP
10
10
 
11
11
  The CLI talks to the hosted registry at `api.releases.sh`. Reader commands work out of the box with no configuration.
12
12
 
13
- > **Admin access is currently closed beta.** `releases admin …` commands require an API key, and API keys are not self-serve yet the hosted registry doesn't expose a public signup flow for them. If you'd like early access, open an issue and we'll get in touch. Everything below the install section assumes reader-only use unless stated otherwise.
13
+ > **Reader access is open; admin access is closed beta.** Search and browse need no account. You can mint a personal **read-only** API key with `releases login` (browser sign-insee [Authentication](#authentication)). `releases admin …` commands need a **write/admin** key, which isn't self-serve yet open an issue for early access. Everything below the install section assumes reader-only use unless stated otherwise.
14
14
 
15
15
  ## Install
16
16
 
@@ -195,7 +195,18 @@ Use this path when you only want the skill behavior (auto-triggering on release/
195
195
 
196
196
  ## Authentication
197
197
 
198
- Admin commands require an API token. You can store one persistently using the `auth` command namespace so you don't need to set `RELEASES_API_KEY` in your shell every time.
198
+ Most commands are reader-only and need no auth. The easiest way to get a personal API key is to sign in through your browser no token to copy or paste:
199
+
200
+ ```bash
201
+ releases login # opens your browser to approve, then saves the key
202
+ releases login --no-browser # print the URL + code to open yourself (headless / SSH)
203
+ ```
204
+
205
+ This uses the OAuth 2.0 Device Authorization Grant (RFC 8628): the CLI shows a short code, you approve it at [releases.sh/device](https://releases.sh/device) in a signed-in browser, and a **read-only** key is minted and saved to `~/.releases/credentials`. Sign up / sign in to the web app first if you haven't. A read-only key is all that's self-serve today; write/admin keys are closed beta (see above).
206
+
207
+ ### Storing a token directly
208
+
209
+ If you've been issued a token (for example a write/admin key during the closed beta), store it without the browser flow using the `auth` namespace, so you don't need `RELEASES_API_KEY` in your shell every time:
199
210
 
200
211
  ```bash
201
212
  releases auth login # interactive prompt (masked input)
@@ -223,7 +234,7 @@ releases auth logout # remove the stored token
223
234
 
224
235
  Nothing is required for reader access. For admin operations (closed beta — see above):
225
236
 
226
- - `RELEASES_API_KEY` — Bearer token for write endpoints. Overrides any stored credential from `releases auth login`. Required for any `releases admin …` command that mutates state if no stored credential is present. Keys are not self-serve right now.
237
+ - `RELEASES_API_KEY` — Bearer token for write endpoints. Overrides any stored credential from `releases login` / `releases auth login`. Required for any `releases admin …` command that mutates state if no stored credential is present. Write/admin keys are not self-serve yet; a personal **read-only** key is available via `releases login`.
227
238
  - `RELEASES_API_URL` — Override the default `https://api.releases.sh` endpoint (useful for staging).
228
239
  - `RELEASES_TELEMETRY_DISABLED=1` — Opt out of anonymous usage pings. `DO_NOT_TRACK=1` is also honored.
229
240
  - `RELEASES_DISABLE_SKILL_UPDATE_CHECK=1` — Silence the "skills are behind, run `releases skills install`" stderr nag that fires (at most once per 24h) when the GitHub `skills/` tree has moved since your last install.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@buildinternet/releases",
3
- "version": "0.56.0",
3
+ "version": "0.57.0",
4
4
  "description": "The changelog & release-notes registry for developers and AI agents",
5
5
  "bin": {
6
6
  "releases": "bin/releases"
@@ -13,11 +13,11 @@
13
13
  "README.md"
14
14
  ],
15
15
  "optionalDependencies": {
16
- "@buildinternet/releases-darwin-arm64": "0.56.0",
17
- "@buildinternet/releases-darwin-x64": "0.56.0",
18
- "@buildinternet/releases-linux-x64": "0.56.0",
19
- "@buildinternet/releases-linux-arm64": "0.56.0",
20
- "@buildinternet/releases-windows-x64": "0.56.0"
16
+ "@buildinternet/releases-darwin-arm64": "0.57.0",
17
+ "@buildinternet/releases-darwin-x64": "0.57.0",
18
+ "@buildinternet/releases-linux-x64": "0.57.0",
19
+ "@buildinternet/releases-linux-arm64": "0.57.0",
20
+ "@buildinternet/releases-windows-x64": "0.57.0"
21
21
  },
22
22
  "keywords": [
23
23
  "changelog",