Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/pl-cli-dlx-docs.md
Original file line number Diff line number Diff line change
@@ -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`.
28 changes: 28 additions & 0 deletions tools/pl-cli/README.md
Original file line number Diff line number Diff line change
@@ -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 <command> [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 <command> --help` for per-command flags.
Loading