@aggc/or-info 0.1.0 → 0.1.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.
Files changed (2) hide show
  1. package/README.md +40 -0
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -13,6 +13,16 @@ to make informed decisions about which model to use.
13
13
 
14
14
  ```bash
15
15
  npm install -g @aggc/or-info
16
+ or-info --version
17
+ ```
18
+
19
+ The npm package is published as `@aggc/or-info`, but the installed executable is
20
+ `or-info`.
21
+
22
+ You can also run it without a global install:
23
+
24
+ ```bash
25
+ npx -y @aggc/or-info models --limit 5
16
26
  ```
17
27
 
18
28
  Requires Node.js 22 or later.
@@ -285,6 +295,36 @@ Additional entry points:
285
295
  - `npm run test:online:smoke` for the live smoke subset used by CI as a non-blocking signal
286
296
  - `npm run test:online` for the full live CLI/MCP suite, including edge cases
287
297
 
298
+ ## Release
299
+
300
+ Releases are published automatically to npm from GitHub Actions when a version tag is pushed.
301
+ The package is public under the `@aggc` npm scope.
302
+
303
+ Release checklist:
304
+
305
+ 1. Update `CHANGELOG.md`.
306
+ 2. Bump `version` in `package.json`.
307
+ 3. Run `npm test`.
308
+ 4. Commit and push to `main`.
309
+ 5. Create and push a matching tag:
310
+
311
+ ```bash
312
+ git tag v0.x.0
313
+ git push origin v0.x.0
314
+ ```
315
+
316
+ The publish workflow runs `npm ci`, `npm run test:local`, then
317
+ `npm publish --provenance --access public`.
318
+
319
+ Repository release requirements:
320
+
321
+ - GitHub secret `NPM_TOKEN` must exist for `jmtrs/or-info`.
322
+ - The token must have npm publish permission for `@aggc/or-info`.
323
+ - `id-token: write` is enabled so npm provenance is attached to published versions.
324
+
325
+ After the initial package bootstrap, prefer migrating to npm Trusted Publishing and then
326
+ remove `NPM_TOKEN` from the repository secrets.
327
+
288
328
  ## Contributing
289
329
 
290
330
  See [CONTRIBUTING.md](CONTRIBUTING.md) — adding new CLI commands or new MCP tools.
package/package.json CHANGED
@@ -1,13 +1,13 @@
1
1
  {
2
2
  "name": "@aggc/or-info",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "CLI + MCP server for OpenRouter models: prices, benchmarks, context and comparisons",
5
5
  "type": "module",
6
6
  "engines": {
7
7
  "node": ">=22"
8
8
  },
9
9
  "bin": {
10
- "or-info": "./bin/or-info.mjs"
10
+ "or-info": "bin/or-info.mjs"
11
11
  },
12
12
  "files": [
13
13
  "bin",