fix(cli): clarify npx and global commands - #610
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
npxis invocation-scoped and a global install enablespascalnpxlifecycle commands and the optional global-install command after every human-readable start, including existing-runtime and already-running pathsVerification
bunx biome check packages/cli/src/bin/pascal.ts packages/cli/src/cli.test.ts packages/cli/scripts/smoke-packed-runtime.tsbun run --cwd packages/cli check-typesbun test packages/cli/src(23 pass)pascal --versionresolvedNote
Low Risk
User-facing copy and help only; editor lifecycle behavior is unchanged aside from consistent stdout after start.
Overview
Clarifies that
npx @pascal-app/cliis per-invocation only and that a global npm install is what enables the shortpascalcommand.Help and docs: Top-level CLI help and the npm README now spell out both invocation patterns. After a human-readable
editor/startsuccess (including already running), the CLI always prints the same follow-up: where projects live,npxexamples forstatus,logs, andstop, and the optionalnpm install --global @pascal-app/cliline—replacing the old branch that only showed “next steps” after a fresh runtime install.Tests: Command-help tests and the packed-runtime smoke assert this guidance stays in place.
Reviewed by Cursor Bugbot for commit 8139ca8. Bugbot is set up for automated code reviews on this repo. Configure here.