Skip to content

feat: add npx support for zero-install trial run#45

Merged
snipcodeit merged 3 commits intomainfrom
issue/22-add-npx-support-for-zero-install
Feb 27, 2026
Merged

feat: add npx support for zero-install trial run#45
snipcodeit merged 3 commits intomainfrom
issue/22-add-npx-support-for-zero-install

Conversation

@snipcodeit
Copy link
Owner

Summary

  • Verified bin/mgw.cjs has correct #!/usr/bin/env node shebang (already present, preserved in built output by pkgroll)
  • Confirmed npx . --help and npx . --version work correctly from repo root
  • Added a Quick Start section to README with npx mgw examples for zero-install trial
  • Documented npx vs full install with a command tier table distinguishing CLI-only commands (issues, sync, link, help) from AI-powered commands that require Claude Code

Closes #22

Milestone Context

  • Milestone: v1 — NPM Publishing & Distribution
  • Phase: 3 — Package Preparation (issue 3/5 in milestone)

Changes

  • README.md — Added Quick Start section with npx examples; added "npx vs full install" subsection under Installation with two-tier command table and requirement details

Test Plan

  • npx . --help prints full command listing from repo root
  • npx . --version prints 0.1.0
  • npx . help prints bundled help text
  • npx . sync runs without error (non-AI command)
  • bin/mgw.cjs source has #!/usr/bin/env node shebang on line 1
  • dist/bin/mgw.cjs built output preserves shebang

Stephen Miller and others added 3 commits February 26, 2026 20:39
Add homepage and bugs fields, expand keywords array with npm
discoverability terms (claude-code, project-management, developer-tools,
ai). Verified existing repository, author, engines, bin, and files
fields are correct. npm pack --dry-run confirms clean 22-file output.

Closes #20

Co-Authored-By: Claude Opus 4.6 <[email protected]>
Exclude development and internal files (.mgw/, .planning/, .worktrees/,
.test/, .github/, .claude/, source lib/ and bin/) from npm package.
Verified with npm pack: 22 files, 58.6 kB — includes only dist/,
commands/, templates/, package.json, README.md, and LICENSE.

Co-Authored-By: Claude Opus 4.6 <[email protected]>
Verify shebang in bin/mgw.cjs (already present), confirm npx . --help
and npx . --version work, and document npx usage in README with a
Quick Start section and an npx-vs-full-install comparison table showing
which commands work without Claude Code installed.

Co-Authored-By: Claude Opus 4.6 <[email protected]>
@github-actions github-actions bot added the documentation Documentation changes label Feb 27, 2026
@snipcodeit snipcodeit merged commit 3dfe85f into main Feb 27, 2026
1 check passed
@snipcodeit snipcodeit deleted the issue/22-add-npx-support-for-zero-install branch February 27, 2026 03:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Documentation changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add npx support for zero-install trial run

1 participant