[object Object]

← back to Cli Printing Press

docs(cli): prefer npx-based installer over raw go install in README (#657)

1afe5da03182ccb28ca49b4dc0a23b92a5cdb739 · 2026-05-07 00:41:46 -0700 · Trevin Chow

Switches the generated README's `## Install` section to lead with
`npx -y @mvanhorn/printing-press install <api>`, which installs both
the CLI binary and the `pp-<api>` agent skill in one shot — the modal
case for users reading the README. A `--cli-only` variant covers
terminal-only setups, and the raw `go install ...@latest` is retained
below as a fallback for environments without Node.

Why: mirrors the SKILL.md change in 8bade0d9, but with one important
difference. The SKILL.md Prerequisites section assumes the user is
already inside an installed skill, so `--cli-only` is the only path
that makes sense there. The README is the entry point for users with
nothing installed, so the default (cli + skill) is the right
recommendation, with `--cli-only` and the Go fallback as alternatives.

The skill is referred to as an "agent skill", not a "Claude Code
skill" — pp-<api> works across Claude Code, Hermes, OpenClaw, and any
other agent surface that consumes the cli-skills/ namespace.

The library-wide sweep tool in
mvanhorn/printing-press-library applies the same shape across the
existing 47 published library/<cat>/<api>/README.md files alongside
this template change.

Goldens regenerated for `generate-golden-api`,
`generate-golden-api-rich-auth`, and `generate-public-param-names`.
Full generator test suite (592 tests) and `scripts/golden.sh verify`
(13/13 cases) pass.

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

Files touched

Diff

commit 1afe5da03182ccb28ca49b4dc0a23b92a5cdb739
Author: Trevin Chow <trevin@trevinchow.com>
Date:   Thu May 7 00:41:46 2026 -0700

    docs(cli): prefer npx-based installer over raw go install in README (#657)
    
    Switches the generated README's `## Install` section to lead with
    `npx -y @mvanhorn/printing-press install <api>`, which installs both
    the CLI binary and the `pp-<api>` agent skill in one shot — the modal
    case for users reading the README. A `--cli-only` variant covers
    terminal-only setups, and the raw `go install ...@latest` is retained
    below as a fallback for environments without Node.
    
    Why: mirrors the SKILL.md change in 8bade0d9, but with one important
    difference. The SKILL.md Prerequisites section assumes the user is
    already inside an installed skill, so `--cli-only` is the only path
    that makes sense there. The README is the entry point for users with
    nothing installed, so the default (cli + skill) is the right
    recommendation, with `--cli-only` and the Go fallback as alternatives.
    
    The skill is referred to as an "agent skill", not a "Claude Code
    skill" — pp-<api> works across Claude Code, Hermes, OpenClaw, and any
    other agent surface that consumes the cli-skills/ namespace.
    
    The library-wide sweep tool in
    mvanhorn/printing-press-library applies the same shape across the
    existing 47 published library/<cat>/<api>/README.md files alongside
    this template change.
    
    Goldens regenerated for `generate-golden-api`,
    `generate-golden-api-rich-auth`, and `generate-public-param-names`.
    Full generator test suite (592 tests) and `scripts/golden.sh verify`
    (13/13 cases) pass.
    
    Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
---
 internal/generator/templates/readme.md.tmpl        | 22 +++++++++++++++++++---
 .../printing-press-rich-auth/README.md             | 22 +++++++++++++++++++---
 .../printing-press-golden/README.md                | 22 +++++++++++++++++++---
 .../public-param-golden/README.md                  | 22 +++++++++++++++++++---
 4 files changed, 76 insertions(+), 12 deletions(-)

diff --git a/internal/generator/templates/readme.md.tmpl b/internal/generator/templates/readme.md.tmpl
index 96bf8863..e8783d3b 100644
--- a/internal/generator/templates/readme.md.tmpl
+++ b/internal/generator/templates/readme.md.tmpl
@@ -18,15 +18,31 @@ Learn more at [{{.ProseName}}]({{.WebsiteURL}}).
 
 ## Install
 
-### Binary
+The recommended path installs both the `{{.Name}}-pp-cli` binary and the `pp-{{.Name}}` agent skill in one shot:
 
-Download a pre-built binary for your platform from the [latest release](https://github.com/mvanhorn/printing-press-library/releases/tag/{{.Name}}-current). On macOS, clear the Gatekeeper quarantine: `xattr -d com.apple.quarantine <binary>`. On Unix, mark it executable: `chmod +x <binary>`.
+```bash
+npx -y @mvanhorn/printing-press install {{.Name}}
+```
 
-### Go
+For CLI only (no skill):
 
+```bash
+npx -y @mvanhorn/printing-press install {{.Name}} --cli-only
 ```
+
+### Without Node (Go fallback)
+
+If `npx` isn't available (no Node, offline), install the CLI directly via Go (requires {{if .UsesBrowserHTTPTransport}}Go 1.25+{{else}}Go 1.23+{{end}}):
+
+```bash
 go install github.com/mvanhorn/printing-press-library/library/{{if .Category}}{{.Category}}{{else}}other{{end}}/{{.Name}}/cmd/{{.Name}}-pp-cli@latest
 ```
+
+This installs the CLI only — no skill.
+
+### Pre-built binary
+
+Download a pre-built binary for your platform from the [latest release](https://github.com/mvanhorn/printing-press-library/releases/tag/{{.Name}}-current). On macOS, clear the Gatekeeper quarantine: `xattr -d com.apple.quarantine <binary>`. On Unix, mark it executable: `chmod +x <binary>`.
 {{- if and .Narrative .Narrative.AuthNarrative}}
 
 {{if .Auth.Optional}}## Optional: API Key{{else}}## Authentication{{end}}
diff --git a/testdata/golden/expected/generate-golden-api-rich-auth/printing-press-rich-auth/README.md b/testdata/golden/expected/generate-golden-api-rich-auth/printing-press-rich-auth/README.md
index 3a137ddc..c4627f46 100644
--- a/testdata/golden/expected/generate-golden-api-rich-auth/printing-press-rich-auth/README.md
+++ b/testdata/golden/expected/generate-golden-api-rich-auth/printing-press-rich-auth/README.md
@@ -4,16 +4,32 @@ Purpose-built fixture for rich auth env-var model coverage.
 
 ## Install
 
-### Binary
+The recommended path installs both the `printing-press-rich-pp-cli` binary and the `pp-printing-press-rich` agent skill in one shot:
 
-Download a pre-built binary for your platform from the [latest release](https://github.com/mvanhorn/printing-press-library/releases/tag/printing-press-rich-current). On macOS, clear the Gatekeeper quarantine: `xattr -d com.apple.quarantine <binary>`. On Unix, mark it executable: `chmod +x <binary>`.
+```bash
+npx -y @mvanhorn/printing-press install printing-press-rich
+```
 
-### Go
+For CLI only (no skill):
 
+```bash
+npx -y @mvanhorn/printing-press install printing-press-rich --cli-only
 ```
+
+### Without Node (Go fallback)
+
+If `npx` isn't available (no Node, offline), install the CLI directly via Go (requires Go 1.23+):
+
+```bash
 go install github.com/mvanhorn/printing-press-library/library/other/printing-press-rich/cmd/printing-press-rich-pp-cli@latest
 ```
 
+This installs the CLI only — no skill.
+
+### Pre-built binary
+
+Download a pre-built binary for your platform from the [latest release](https://github.com/mvanhorn/printing-press-library/releases/tag/printing-press-rich-current). On macOS, clear the Gatekeeper quarantine: `xattr -d com.apple.quarantine <binary>`. On Unix, mark it executable: `chmod +x <binary>`.
+
 ## Quick Start
 
 ### 1. Install
diff --git a/testdata/golden/expected/generate-golden-api/printing-press-golden/README.md b/testdata/golden/expected/generate-golden-api/printing-press-golden/README.md
index 0cd4cca7..d3cd2889 100644
--- a/testdata/golden/expected/generate-golden-api/printing-press-golden/README.md
+++ b/testdata/golden/expected/generate-golden-api/printing-press-golden/README.md
@@ -4,16 +4,32 @@ Purpose-built fixture for golden generation coverage.
 
 ## Install
 
-### Binary
+The recommended path installs both the `printing-press-golden-pp-cli` binary and the `pp-printing-press-golden` agent skill in one shot:
 
-Download a pre-built binary for your platform from the [latest release](https://github.com/mvanhorn/printing-press-library/releases/tag/printing-press-golden-current). On macOS, clear the Gatekeeper quarantine: `xattr -d com.apple.quarantine <binary>`. On Unix, mark it executable: `chmod +x <binary>`.
+```bash
+npx -y @mvanhorn/printing-press install printing-press-golden
+```
 
-### Go
+For CLI only (no skill):
 
+```bash
+npx -y @mvanhorn/printing-press install printing-press-golden --cli-only
 ```
+
+### Without Node (Go fallback)
+
+If `npx` isn't available (no Node, offline), install the CLI directly via Go (requires Go 1.23+):
+
+```bash
 go install github.com/mvanhorn/printing-press-library/library/other/printing-press-golden/cmd/printing-press-golden-pp-cli@latest
 ```
 
+This installs the CLI only — no skill.
+
+### Pre-built binary
+
+Download a pre-built binary for your platform from the [latest release](https://github.com/mvanhorn/printing-press-library/releases/tag/printing-press-golden-current). On macOS, clear the Gatekeeper quarantine: `xattr -d com.apple.quarantine <binary>`. On Unix, mark it executable: `chmod +x <binary>`.
+
 ## Quick Start
 
 ### 1. Install
diff --git a/testdata/golden/expected/generate-public-param-names/public-param-golden/README.md b/testdata/golden/expected/generate-public-param-names/public-param-golden/README.md
index 9f9c521f..e20c9643 100644
--- a/testdata/golden/expected/generate-public-param-names/public-param-golden/README.md
+++ b/testdata/golden/expected/generate-public-param-names/public-param-golden/README.md
@@ -4,16 +4,32 @@ Public parameter name golden fixture
 
 ## Install
 
-### Binary
+The recommended path installs both the `public-param-golden-pp-cli` binary and the `pp-public-param-golden` agent skill in one shot:
 
-Download a pre-built binary for your platform from the [latest release](https://github.com/mvanhorn/printing-press-library/releases/tag/public-param-golden-current). On macOS, clear the Gatekeeper quarantine: `xattr -d com.apple.quarantine <binary>`. On Unix, mark it executable: `chmod +x <binary>`.
+```bash
+npx -y @mvanhorn/printing-press install public-param-golden
+```
 
-### Go
+For CLI only (no skill):
 
+```bash
+npx -y @mvanhorn/printing-press install public-param-golden --cli-only
 ```
+
+### Without Node (Go fallback)
+
+If `npx` isn't available (no Node, offline), install the CLI directly via Go (requires Go 1.23+):
+
+```bash
 go install github.com/mvanhorn/printing-press-library/library/other/public-param-golden/cmd/public-param-golden-pp-cli@latest
 ```
 
+This installs the CLI only — no skill.
+
+### Pre-built binary
+
+Download a pre-built binary for your platform from the [latest release](https://github.com/mvanhorn/printing-press-library/releases/tag/public-param-golden-current). On macOS, clear the Gatekeeper quarantine: `xattr -d com.apple.quarantine <binary>`. On Unix, mark it executable: `chmod +x <binary>`.
+
 ## Quick Start
 
 ### 1. Install

← 83d2bb19 docs(cli): expand commit-style guidance with type list and b  ·  back to Cli Printing Press  ·  docs(cli): tighten README and drop stale catalog counts (#65 07c8f637 →