Skip to content

docs: public install in README; internal package + split in CONTRIBUTING #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vigubikReply merged 1 commit into from
Jul 23, 2026
Merged

docs: public install in README; internal package + split in CONTRIBUTING #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <GITHUB_TOKEN> # 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/).
Expand Down
7 changes: 2 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading