Skip to content

docs: document Windows/PowerShell npx invocation#104

Merged
davideast merged 1 commit into
google-labs-code:mainfrom
mvanhorn:docs/93-windows-npx
Jun 11, 2026
Merged

docs: document Windows/PowerShell npx invocation#104
davideast merged 1 commit into
google-labs-code:mainfrom
mvanhorn:docs/93-windows-npx

Conversation

@mvanhorn

@mvanhorn mvanhorn commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Summary

Documents the working npx invocation for Windows/PowerShell users in the README installation section.

Why this matters (#93)

Running npx @google/design.md lint DESIGN.md in PowerShell on Windows produces no output, and in some cases Windows opens the DESIGN.md file in a Markdown editor instead of running the CLI. The root cause is the design.md bin name: the .md suffix collides with the Windows Markdown file association during command resolution, so the token resolves to a file rather than the npm shim.

The package already ships a dot-free designmd bin alias pointing at the same entrypoint, and the README already documents it for the package.json-script case. The gap was the direct-npx case that #93 is specifically about.

Changes

  • README: added a Windows/PowerShell note right after the direct-npx install example, pointing users at npx -p @google/design.md designmd lint DESIGN.md and briefly explaining the .md file-association collision. Wording is kept consistent with the existing designmd-alias guidance for the scripts case.

Docs-only; no code touched.

Testing

  • Verified against packages/cli/package.json: the bin map exposes both design.md and designmd, both pointing at ./dist/index.js, so the documented designmd alias is accurate and resolves to the same entrypoint.
  • Confirmed the macOS/Linux npx @google/design.md lint DESIGN.md instructions are unchanged.
  • Markdown code fences are balanced and the new note is consistent with the pre-existing designmd-alias tip.

Fixes #93.

@davideast davideast left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thank you @mvanhorn! I've been looking into solutions here and I think this is absolutely the best start for now.

@davideast davideast merged commit b6173b6 into google-labs-code:main Jun 11, 2026
8 checks passed
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.

No output / appears to silently exit when running lint in PowerShell on Windows

2 participants