Skip to content

fix(cli): clarify npx and global commands - #610

Merged
Aymericr merged 1 commit into
mainfrom
fix/cli-npx-guidance
Aug 7, 2026
Merged

fix(cli): clarify npx and global commands#610
Aymericr merged 1 commit into
mainfrom
fix/cli-npx-guidance

Conversation

@Aymericr

@Aymericr Aymericr commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Summary

  • explain in CLI help that npx is invocation-scoped and a global install enables pascal
  • print runnable npx lifecycle commands and the optional global-install command after every human-readable start, including existing-runtime and already-running paths
  • document the same distinction in the npm README
  • require the packed-runtime smoke to preserve this guidance

Verification

  • bunx biome check packages/cli/src/bin/pascal.ts packages/cli/src/cli.test.ts packages/cli/scripts/smoke-packed-runtime.ts
  • bun run --cwd packages/cli check-types
  • bun test packages/cli/src (23 pass)
  • portable editor build, stage, and packed-runtime smoke
  • packed tarball installed under an isolated global npm prefix; pascal --version resolved
  • revised existing-runtime output exercised against the reported healthy local editor

Note

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/cli is per-invocation only and that a global npm install is what enables the short pascal command.

Help and docs: Top-level CLI help and the npm README now spell out both invocation patterns. After a human-readable editor / start success (including already running), the CLI always prints the same follow-up: where projects live, npx examples for status, logs, and stop, and the optional npm install --global @pascal-app/cli line—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.

@Aymericr
Aymericr merged commit efa7955 into main Aug 7, 2026
3 checks passed
@Aymericr
Aymericr deleted the fix/cli-npx-guidance branch August 7, 2026 14:23
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.

1 participant