From acc1dc1b9e027c9e73617a32816a713c3b8117ce Mon Sep 17 00:00:00 2001 From: Dmitry Bolotin Date: Wed, 15 Apr 2026 19:19:35 +0200 Subject: [PATCH 1/2] docs(pl-cli): document required --allow-build flag for pnpm dlx --- .changeset/pl-cli-dlx-docs.md | 5 +++++ tools/pl-cli/README.md | 28 ++++++++++++++++++++++++++++ 2 files changed, 33 insertions(+) create mode 100644 .changeset/pl-cli-dlx-docs.md create mode 100644 tools/pl-cli/README.md diff --git a/.changeset/pl-cli-dlx-docs.md b/.changeset/pl-cli-dlx-docs.md new file mode 100644 index 0000000000..04a024a3f2 --- /dev/null +++ b/.changeset/pl-cli-dlx-docs.md @@ -0,0 +1,5 @@ +--- +--- + +Docs-only: add README to `@platforma-sdk/pl-cli` documenting required +`--allow-build=@milaboratories/pframes-rs-node` flag for `pnpm dlx`. diff --git a/tools/pl-cli/README.md b/tools/pl-cli/README.md new file mode 100644 index 0000000000..241d1797f9 --- /dev/null +++ b/tools/pl-cli/README.md @@ -0,0 +1,28 @@ +# @platforma-sdk/pl-cli + +CLI for Platforma server state manipulation. + +## Usage + +```bash +pnpm dlx --allow-build=@milaboratories/pframes-rs-node \ + @platforma-sdk/pl-cli [args...] +``` + +The `--allow-build=@milaboratories/pframes-rs-node` flag is **required**. +Without it you will get: + +``` +ModuleLoadError: Cannot find module '.../pframes_rs_node.node' +``` + +## Commands + +- `admin copy-project` — copy a project between users (requires admin credentials) +- `project list` — list projects for a user +- `project info` — show project metadata +- `project duplicate` — duplicate a project +- `project rename` — rename a project +- `project delete` — delete a project + +Run `pl-cli --help` for per-command flags. From 7aba945382fb475d221380024c92ce311cdf45d4 Mon Sep 17 00:00:00 2001 From: Dmitry Bolotin Date: Wed, 15 Apr 2026 20:41:16 +0300 Subject: [PATCH 2/2] Update tools/pl-cli/README.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> --- tools/pl-cli/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tools/pl-cli/README.md b/tools/pl-cli/README.md index 241d1797f9..bac9f1e510 100644 --- a/tools/pl-cli/README.md +++ b/tools/pl-cli/README.md @@ -21,8 +21,8 @@ ModuleLoadError: Cannot find module '.../pframes_rs_node.node' - `admin copy-project` — copy a project between users (requires admin credentials) - `project list` — list projects for a user - `project info` — show project metadata -- `project duplicate` — duplicate a project -- `project rename` — rename a project -- `project delete` — delete a project +- `project duplicate` — Create a copy of an existing project +- `project rename` — Change the name of a project +- `project delete` — Permanently remove a project Run `pl-cli --help` for per-command flags.