Skip to content

Document the published npm release candidate #7

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
fatihguner merged 1 commit into from
Sep 5, 2026
Merged

Document the published npm release candidate #7

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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,10 +151,10 @@ Add `--platform codex` for Codex, or `--platform all` for both Claude and Codex.
### npm registry

```bash
npx foreman-sh init
npx foreman-sh@next init
```

The unversioned npm command selects the existing stable registry release, which does not include this candidate's fixes. Use the GitHub package above for this candidate until npm publication is confirmed.
The `next` channel installs the current release candidate. Use `npx foreman-sh@1.1.0-rc.1 init` to pin this exact version. The unversioned command still selects the older stable release.

The new installer adds `.claude/` and `CLAUDE.md` to your current directory and preserves existing files. Use `--workspace /path/to/project` to choose a directory or `--platform codex` to install project skills under `.agents/skills/`. Open Claude Code and start talking:

Expand Down
10 changes: 9 additions & 1 deletion docs/releases/v1.1.0-rc.1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,14 @@ Foreman now installs as a complete package with working commands and shared pers

Requires Node 22.19 or newer and a supported AI host.

Install from npm:

```sh
npx foreman-sh@next init
```

Use `npx foreman-sh@1.1.0-rc.1 init` to pin this exact version. The same package is also available directly from GitHub:

```sh
npx --yes --package=https://github.com/fatihguner/foreman/releases/download/v1.1.0-rc.1/foreman-sh-1.1.0-rc.1.tgz foreman-sh init
```
Expand All @@ -21,7 +29,7 @@ Claude Code plugin installation:

Plugin commands use names such as `/foreman:solo` and `/foreman:apply`. Project commands use `/solo` and `/apply`. In Codex, invoke `$foreman` with the desired operation.

The GitHub release includes the npm tarball and its SHA-256 checksum. The npm registry's stable channel remains separate; this candidate is intended for the `next` channel once npm publishing is configured.
The GitHub release includes the npm tarball and its SHA-256 checksum. npm's `next` channel points to 1.1.0-rc.1; the stable `latest` channel remains 1.0.0. The npm and GitHub tarballs have identical integrity hashes.

## Changes

Expand Down
Loading