Skip to content

docs(pl-cli): document required --allow-build flag for pnpm dlx#1568

Open
dbolotin wants to merge 2 commits into
mainfrom
docs/pl-cli-pnpm-dlx-usage
Open

docs(pl-cli): document required --allow-build flag for pnpm dlx#1568
dbolotin wants to merge 2 commits into
mainfrom
docs/pl-cli-pnpm-dlx-usage

Conversation

@dbolotin

@dbolotin dbolotin commented Apr 15, 2026

Copy link
Copy Markdown
Member

Summary

Adds a README to @platforma-sdk/pl-cli showing the correct pnpm dlx
invocation. @milaboratories/pframes-rs-node needs its install script to
run (node-pre-gyp downloads the native .node binary); on pnpm 10 the
only way to allow that in a dlx context is the --allow-build CLI flag.
Without it, the CLI fails at runtime with MODULE_NOT_FOUND for
pframes_rs_node.node.

Empty changeset — no publish impact; files already includes the README
so it ships on the next release.

Greptile Summary

Adds a README.md to @platforma-sdk/pl-cli documenting the pnpm dlx --allow-build=@milaboratories/pframes-rs-node invocation required on pnpm 10, along with a brief command reference. The README is already listed in package.json's files field and all documented commands match actual source files under src/cmd/.

Confidence Score: 5/5

Safe to merge — docs-only change with no code modifications.

Both files are purely additive documentation. The README accurately reflects the codebase (all commands verified against source), the package.json already includes README.md in files, and the empty changeset format is correct for a non-versioning change.

No files require special attention.

Important Files Changed

Filename Overview
tools/pl-cli/README.md New README documenting pnpm dlx usage with --allow-build flag; all listed commands match actual source files
.changeset/pl-cli-dlx-docs.md Empty changeset (no version bumps) for docs-only change — correct format for non-versioning PRs

Reviews (1): Last reviewed commit: "docs(pl-cli): document required --allow-..." | Re-trigger Greptile

@changeset-bot

changeset-bot Bot commented Apr 15, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 7aba945

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 0 packages

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request adds a README for the @platforma-sdk/pl-cli package and a changeset documenting the required --allow-build flag for pnpm dlx. The documentation includes a list of CLI commands. Feedback was provided to improve the clarity of command descriptions in the README by making them more descriptive.

Comment thread tools/pl-cli/README.md Outdated
@codecov

codecov Bot commented Apr 15, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 54.05%. Comparing base (3657a2c) to head (7aba945).
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1568      +/-   ##
==========================================
- Coverage   55.85%   54.05%   -1.80%     
==========================================
  Files         198      255      +57     
  Lines       10774    14603    +3829     
  Branches     2306     3027     +721     
==========================================
+ Hits         6018     7894    +1876     
- Misses       3996     5695    +1699     
- Partials      760     1014     +254     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
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.

2 participants