From 8596bfec7252ac55395121fd413b6425a175a612 Mon Sep 17 00:00:00 2001 From: vigubikReply Date: Thu, 23 Jul 2026 17:45:15 -0400 Subject: [PATCH] docs: public install in README; move internal-package install + 2-package split to CONTRIBUTING README now installs the public reply-cli from npm. The GitHub Packages instructions and the public/internal split move to CONTRIBUTING. Co-Authored-By: Claude Opus 4.8 (1M context) --- CONTRIBUTING.md | 24 ++++++++++++++++++++++++ README.md | 7 ++----- 2 files changed, 26 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 165a5a9..8de2f72 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -79,6 +79,30 @@ Any field left off is inherited from the default (prod). Profiles live in { "profiles": { "dev": { "authority": "https://…", "api_base": "https://…/v3" } } } ``` +## Packages: public vs internal + +The same source ships as **two npm packages** (both expose the `reply` bin — +identical commands and flags; only the package name and registry differ): + +| Package | Registry | For | Install | +|---|---|---|---| +| `reply-cli` | public npm | end users | `npm install -g reply-cli` | +| `@reply-team/reply-cli` | GitHub Packages | the team, to test pre-release builds | see below | + +A public `X.Y.Z` is byte-for-byte the internal tag `vX.Y.Z` — promoted, not rebuilt +differently. + +To install an **internal build** (the newest green `main`, published on every +qualifying merge), point the `@reply-team` scope at GitHub Packages and authenticate +with a GitHub token that has `read:packages`: + +```sh +npm config set @reply-team:registry https://npm.pkg.github.com +npm config set //npm.pkg.github.com/:_authToken # read:packages +npm install -g @reply-team/reply-cli # newest internal build (@latest) +npm install -g @reply-team/reply-cli@0.3.0 # a specific build +``` + ## Releases Releases are automated with [semantic-release](https://semantic-release.gitbook.io/). diff --git a/README.md b/README.md index 8377dab..e3fd4a7 100644 --- a/README.md +++ b/README.md @@ -8,13 +8,10 @@ contacts, and the inbox are on the way. ## Installation -Requires [Node.js](https://nodejs.org) 20 or newer. The CLI is published to -GitHub Packages under the `@reply-team` scope, so point that scope at the -registry once, then install globally: +Requires [Node.js](https://nodejs.org) 20 or newer. Install globally from npm: ```sh -echo "@reply-team:registry=https://npm.pkg.github.com" >> ~/.npmrc -npm install -g @reply-team/reply-cli +npm install -g reply-cli ``` ```sh