The CLI multitool for Platforma Block developers.

Installation

npm install --global @platforma-sdk/bootstrap@latest
# or
pnpm install --global @platforma-sdk/bootstrap@latest

or use it without installation with

npx @platforma-sdk/bootstrap@latest '<args>'
# or
pnpx @platforma-sdk/bootstrap@latest '<args>'

Key features:

• empty block skeleton generation
• local Platforma Backend service control

Usage:

pl-dev '<command>'
# or without installation
npx @platforma-sdk/bootstrap@latest '<command>'

The tool has 'tree' command structure, like aws-cli, docker, git and many other CLI software: commands about specific type of operations are grouped under common prefix, i.e. all operations for platforma backend service instances are under svc group:

pl-dev svc create --help

All commands have --help flag that make the command to report its usage information:

pl-dev --help

Local Platforma Backend service control

To create, change, start, stop and delete Platforma Backend on your local computer, use commands in svc group:

• pl-dev svc create docker NAME creates instance of Platforma Backend inside docker container on your local computer. You can start/stop this instance with svc up NAME and svc down NAME commands, and connect to it via localhost:6345 address.
• pl-dev svc list lists available service instances you created earlier.

Here are few examples on how to prepare your first instance of Platforma Backend started right on your laptop without any containerisation:

pl-dev svc create local MyLocalPl
pl-dev svc up MyLocalPl

The tool will download Platforma Backend archive for your OS and architecture, generate configuration file and all necessary directories. up command will make the service instance start.

How-To's

NOTE: after creating instances with svc create * <NAME> command, start this instance with svc up <NAME>. Only one instance for user can be started at a time for now. When you call up for one instance, all other instances get stopped automatically.

• Docker-based:
  • Create docker container, starting fake S3 service (minio) locally to use it as a primary storage:

    pl-dev svc create docker s3 MyInstance

  • Create docker container, connecting it to AWS S3 bucket myAwesomeBucket as a primary storage, keeping all the data under some-prefix prefix inside the bucket:

    pl-dev svc create docker MyInstance --storage-primary "s3://myAwesomeBucket/some-prefix?region=eu-central-1"

  • Mount custom directory with dev blocks from the host into docker container:

    pl-dev svc create docker MyInstance --mount /home/myusername/platforma-dev/blocks/

• Local instances:
  • Create service that starts locally on current host (no containers) and uses custom S3 service (not AWS) as library:

    pl-dev svc create local MyInstance --storage-library "s3es://my-corporate-s3.example.com/rawDataBucket/?region=company-internal-region"

Block skeleton generation

To create new block skeleton, run

pl-dev create-block