docs(readme): show all four install paths#90
Merged
Conversation
fujibee
force-pushed
the
docs/install-paths
branch
from
951b1a7 to
9769c82
Compare
Adds two install paths the README didn't cover after the PH-launch rework: - **npm / npx** — published since #89 via npm Trusted Publisher (OIDC) with SLSA provenance. `npx agmsg` is the lowest-friction path for Node-having users. - **Claude Code plugin marketplace** — `/plugin marketplace add fujibee/agmsg` + `/plugin install agmsg@fujibee-agmsg` + `/reload-plugins` + `/agmsg`. Verified end-to-end against a fresh Debian-based Claude Code container today: the in-CC slash command flow runs the SKILL.md Step 0 bootstrap (added in #85) and lands on the same `~/.agents/skills/agmsg/` runtime as the direct-script install. Also surfaces the `bash + sqlite3` prerequisite at the top of Quick Start. The dogfood revealed that minimal Linux images (Debian slim, etc.) don't include sqlite3 by default; the bootstrap installer surfaces a clear error, but it's worth flagging up front. macOS users are unaffected. The Install section is restructured into subsections (npm, plugin marketplace, direct script) so each path stands on its own. A note in the direct-script subsection clarifies that `--cmd` / `--agent-type` flags are direct-script only — the other paths always install as `agmsg` with auto-detected agent type.
git clone / setup.sh install from main (always current); the npm package and Claude Code plugin are cut from tagged releases and can lag. Point readers at `/agmsg version` to see exactly what they're running (#117 provenance).
fujibee
force-pushed
the
docs/install-paths
branch
from
9769c82 to
cebae9e
Compare
- Direct script section now shows the `git clone` + `cd` it assumed, and notes it's the path that tracks latest main. - Community: credit @lucianlamp (native Windows PowerShell helpers, #103) and @tatsuya6502 (sandboxed Bash tool support, #106) — merged but uncredited.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Reflects the verified state of agmsg's install paths after PR #94's PH-launch README rework and today's clean-container dogfood of the Claude Code plugin install path.
Summary
npm/npxand the Claude Code plugin marketplace.bash+sqlite3prerequisite at the top of Quick Start (today's dogfood revealed minimal Debian containers don't include sqlite3).npm/ plugin marketplace / direct script — so each path is independently readable.Verification (today)
Clean Debian-based Claude Code container (built via the
create-claude-agentskill, fresh~/.claude/, no agmsg state) walked through:/plugin marketplace add fujibee/agmsg— ✅/plugin install agmsg@fujibee-agmsg(user scope) — ✅/reload-plugins— ✅/agmsg— LLM read SKILL.md, hit Step 0 bootstrap, surfaced sqlite3-missing errorsudo apt-get install -y sqlite3, re-ran the bootstrap — ✅~/.agents/skills/agmsg/populatedwhoami→not_joined=true→ join.sh → inbox/team verification — ✅The npm path was end-to-end verified in #89's release pipeline (npm
agmsg@1.0.2published via Trusted Publisher OIDC with SLSA provenance attestation).Notes
/plugin install agmsg(single command). Leaving the explicitmarketplace add fujibee/agmsgform here works regardless of Submit agmsg to Anthropic community plugin marketplace #77 status.Test plan
npx agmsgverified via release: single source of truth for version + CI release pipeline #89 publish flow./plugin install agmsg@fujibee-agmsgverified end-to-end in clean container today (this PR).verify-versionsCI: docs-only change, no version-derived files touched.