diff --git a/.npmignore b/.npmignore new file mode 100644 index 0000000..dfe983f --- /dev/null +++ b/.npmignore @@ -0,0 +1,39 @@ +# MGW npm package exclusions +# Defense-in-depth: package.json "files" field is the primary allowlist. +# This file provides an additional safety net to prevent accidental inclusion +# of development, CI, and internal files. + +# Internal project management +.mgw/ +.planning/ +.worktrees/ +.test/ + +# CI/CD and GitHub +.github/ + +# Claude Code +.claude/ + +# Git +.git +.gitignore + +# Node +node_modules/ + +# Source (distributed as built dist/) +lib/ +bin/ + +# Markdown docs (README.md is always included by npm) +CONTRIBUTING.md +CODEOWNERS + +# Editor artifacts +*.swp +*.swo +.DS_Store + +# Build tooling config +package-lock.json diff --git a/README.md b/README.md index b26c58e..a501d3f 100644 --- a/README.md +++ b/README.md @@ -155,6 +155,26 @@ The `/mgw:sync` command reconciles local state with GitHub reality — archiving - [GitHub CLI](https://cli.github.com/) (`gh`) authenticated - A GitHub repository with issues enabled +## Quick Start + +Try MGW without installing anything: + +```bash +# See available commands +npx mgw --help + +# List your open issues +npx mgw issues + +# Sync local state with GitHub +npx mgw sync + +# Cross-reference two issues +npx mgw link 42 43 +``` + +`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. + ## Installation ### Full install (CLI + slash commands) @@ -198,6 +218,17 @@ Then in Claude Code: /mgw:help ``` +### npx vs full install + +Not all commands work via `npx`. The CLI has two tiers: + +| Tier | Commands | Requirements | +|------|----------|--------------| +| **CLI-only** (works with npx) | `issues`, `sync`, `link`, `help`, `--help`, `--version` | Node.js >= 18, `gh` CLI | +| **AI-powered** (requires full install) | `run`, `init`, `project`, `milestone`, `next`, `issue`, `update`, `pr` | Node.js >= 18, `gh` CLI, Claude Code CLI, GSD | + +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. + ## Typical Workflow ### New project (from scratch) diff --git a/package.json b/package.json index 501bbe2..322fa7b 100644 --- a/package.json +++ b/package.json @@ -29,7 +29,20 @@ "type": "git", "url": "git+https://github.com/snipcodeit/mgw.git" }, - "keywords": ["github", "cli", "automation", "pipeline", "gsd"], + "keywords": [ + "claude-code", + "github", + "automation", + "project-management", + "gsd", + "cli", + "developer-tools", + "ai" + ], "author": "snipcodeit", - "license": "MIT" + "license": "MIT", + "homepage": "https://github.com/snipcodeit/mgw", + "bugs": { + "url": "https://github.com/snipcodeit/mgw/issues" + } }