Skip to content

Commit 3dfe85f

Browse files
authored
Merge pull request #45 from snipcodeit/issue/22-add-npx-support-for-zero-install
feat: add npx support for zero-install trial run
2 parents 0ffd276 + c05c281 commit 3dfe85f

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,26 @@ The `/mgw:sync` command reconciles local state with GitHub reality — archiving
155155
- [GitHub CLI](https://cli.github.com/) (`gh`) authenticated
156156
- A GitHub repository with issues enabled
157157

158+
## Quick Start
159+
160+
Try MGW without installing anything:
161+
162+
```bash
163+
# See available commands
164+
npx mgw --help
165+
166+
# List your open issues
167+
npx mgw issues
168+
169+
# Sync local state with GitHub
170+
npx mgw sync
171+
172+
# Cross-reference two issues
173+
npx mgw link 42 43
174+
```
175+
176+
`npx mgw` gives you the full CLI subset that works without Claude Code. For the AI-powered pipeline commands (`run`, `issue`, `project`, `milestone`, etc.), do a full install below.
177+
158178
## Installation
159179

160180
### Full install (CLI + slash commands)
@@ -198,6 +218,17 @@ Then in Claude Code:
198218
/mgw:help
199219
```
200220

221+
### npx vs full install
222+
223+
Not all commands work via `npx`. The CLI has two tiers:
224+
225+
| Tier | Commands | Requirements |
226+
|------|----------|--------------|
227+
| **CLI-only** (works with npx) | `issues`, `sync`, `link`, `help`, `--help`, `--version` | Node.js >= 18, `gh` CLI |
228+
| **AI-powered** (requires full install) | `run`, `init`, `project`, `milestone`, `next`, `issue`, `update`, `pr` | Node.js >= 18, `gh` CLI, Claude Code CLI, GSD |
229+
230+
AI-powered commands call `claude -p` under the hood and require the [Claude Code CLI](https://docs.anthropic.com/en/docs/claude-code/overview) to be installed and authenticated. The slash command `.md` files must also be deployed to `~/.claude/commands/mgw/` for the full pipeline to work. Use `npx mgw` to explore the CLI and verify your GitHub setup before committing to a full install.
231+
201232
## Typical Workflow
202233

203234
### New project (from scratch)

0 commit comments

Comments
 (0)