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..bac9f1e510 --- /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` — 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.