Skip to content

Remove npm/npx as the recommended install path - #7

Merged
vibhusharma101 merged 1 commit into
mainfrom
docs/remove-npm-install-path
Jul 22, 2026
Merged

Remove npm/npx as the recommended install path#7
vibhusharma101 merged 1 commit into
mainfrom
docs/remove-npm-install-path

Conversation

@vibhusharma101

Copy link
Copy Markdown
Owner

Summary

  • Publishing to npm is paused, so npm/npx should no longer be the primary "how to install" story for free users — the GitHub repo is now the one recommended path.
  • Docs updated: README.md, adapters/README.md, adapters/claude-code/SKILL.md, adapters/codex/AGENTS.md, docs/extending.md, install.sh header comment. All now lead with git clone + node bin/cli.mjs init, or the curl one-liner — no npm/npx anywhere.
  • Real fix, not just docs: bin/cli.mjs's cmdInit() previously wrote adapter templates that told the AI tool to shell out to npx think-in-html instructions/check/build — that would be actively broken advice once npm isn't recommended. Replaced the embedded (already drifted) template strings with logic that copies the engine to <project>/think-in-html/core/ and reads the real per-tool adapter files, rewriting their core/ references to think-in-html/core/ — the same transform install.sh already does via sed. The CLI and the curl installer can no longer drift apart, since cmdInit() now reads the same source files instead of maintaining its own copies.
  • README's "Maintainers" section softened to note npm publishing is paused; PUBLISHING.md and LANDING-PLAN.md left as historical/maintainer reference (not user-facing install docs).

Test plan

  • npm test — 18/18 passing
  • Ran node bin/cli.mjs init against a scratch project: engine copied to think-in-html/core/, all three adapters (Claude Code, Cursor, Codex) wired, paths correctly rewritten, zero npx references in any generated output
  • node bin/cli.mjs --help / instructions code / check still work when run via node bin/cli.mjs <cmd> from the clone

Risks

None — no published npm package exists to break; this only changes docs and the local init codepath.

Rollback

Revert this commit; cmdInit() goes back to the npx-based templates (which were already stale/broken advice regardless).

…l.sh only

Publishing to npm isn't happening right now, so npm/npx should no longer be
the primary story for free users. The repo (via git clone or the
install.sh curl one-liner) is now the one recommended install path
everywhere: README, adapters/README.md, adapters/claude-code/SKILL.md,
adapters/codex/AGENTS.md, docs/extending.md.

bin/cli.mjs required a real fix, not just doc changes: `cmdInit()` wrote
adapter templates that told the AI tool to shell out to `npx think-in-html`
for instructions/check/build — which would now be flat-out broken advice.
Replaced those embedded, already-drifted template strings with logic that:
  - copies the engine into <project>/think-in-html/core/ (cpSync), same as
    install.sh's cp step
  - reads the real, dogfooded adapter files (.claude/commands/think-in-html.md,
    .cursor/rules/think-in-html.mdc, adapters/codex/AGENTS.md) and rewrites
    their bare `core/` references to `think-in-html/core/` — mirroring
    install.sh's `sed 's|core/|think-in-html/core/|g'`

This makes `node bin/cli.mjs init` produce the exact same result as the
curl installer, and the two paths can no longer drift apart since cli.mjs
now reads the same source files instead of maintaining its own copies.

Verified: ran `node bin/cli.mjs init` against a scratch project — engine
copied, all three adapters wired, paths rewritten correctly, zero `npx`
references anywhere in the output. `npm test` still 18/18.

Left PUBLISHING.md and LANDING-PLAN.md as historical/maintainer reference
(not user-facing install instructions); softened the README's pointer to
PUBLISHING.md to note publishing is paused.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@vibhusharma101
vibhusharma101 merged commit c928493 into main Jul 22, 2026
3 checks passed
@vibhusharma101
vibhusharma101 deleted the docs/remove-npm-install-path branch July 22, 2026 18:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant