@platforma-sdk/block-tools

npm install @platforma-sdk/block-tools

Usage

``sh-session $ npm install -g @platforma-sdk/block-tools $ block-tools COMMAND running command... $ block-tools (--version) @platforma-sdk/block-tools/2.5.92 darwin-arm64 node-v20.19.4 $ block-tools --help [COMMAND] USAGE $ block-tools COMMAND ...`

`Commands`

- block-tools build-meta-block-tools build-model-block-tools list-overview-snapshots-block-tools mark-stable-block-tools pack-block-tools publish-block-tools refresh-registry-block-tools restore-overview-from-snapshot-block-tools upload-package-v1

block-tools build-meta

Extracts meta information from blocks package.json and outputs meta.json with embedded binary and textual information linked from the meta section.

`USAGE $ block-tools build-meta -o [-i ]

FLAGS -i, --modulePath= [default: .] input module path -o, --destination= (required) output meta.json file

DESCRIPTION Extracts meta information from blocks package.json and outputs meta.json with embedded binary and textual information linked from the meta section.`

block-tools build-model

Extracts and outputs block model JSON from pre-built block model module

`USAGE $ block-tools build-model [-i ] [-b ] [-o ]

FLAGS -b, --sourceBundle= [default: ./dist/bundle.js] bundled model code to embed into the model for callback-based rendering to work -i, --modulePath= [default: .] input module path -o, --destination= [default: ./dist/model.json] output model file

DESCRIPTION Extracts and outputs block model JSON from pre-built block model module`

block-tools list-overview-snapshots

List all available global overview snapshots in the registry

`USAGE $ block-tools list-overview-snapshots -r

 [--json]
FLAGS
  -r, --registry=

  (required) full address of the registry
      --json                output in JSON format

DESCRIPTION List all available global overview snapshots in the registry`

block-tools mark-stable

Mark target block stable

`USAGE $ block-tools mark-stable -r

 [-i ] [-v ] [--refresh] [--unmark]
FLAGS
  -i, --modulePath=         [default: .] input module path
  -r, --registry=

        (required) full address of the registry
  -v, --version-override=  override package version
      --[no-]refresh              refresh repository after adding the package
      --unmark                    reverses meaning of this command, flag can be used to remove "stable" flag from the
                                  package

DESCRIPTION Mark target block stable`

block-tools pack

Builds block pack and outputs a block pack manifest consolidating all references assets into a single folder

`USAGE $ block-tools pack [-i ] [-o ]

FLAGS -i, --modulePath= [default: .] input module path -o, --destinationPath= [default: ./block-pack] output folder

DESCRIPTION Builds block pack and outputs a block pack manifest consolidating all references assets into a single folder`

block-tools publish

Publishes the block package and refreshes the registry (for v2 block-pack schema)

`USAGE $ block-tools publish -r

 [-m ] [-v ] [--refresh] [--unstable]
FLAGS
  -m, --manifest=          [default: ./block-pack/manifest.json] manifest file path
  -r, --registry=

        (required) full address of the registry
  -v, --version-override=  override package version
      --[no-]refresh              refresh repository after adding the package
      --unstable                  do not add the published package to stable channel

DESCRIPTION Publishes the block package and refreshes the registry (for v2 block-pack schema)`

block-tools refresh-registry

Refresh overview files based on published but not proecessed artefacts

`USAGE $ block-tools refresh-registry -r

 [-m ]
FLAGS
  -m, --mode=         [default: normal] refresh mode (allowed valiues: "force", "normal", "dry-run")
  -r, --registry=

(required) full address of the registry

DESCRIPTION Refresh overview files based on published but not proecessed artefacts`

block-tools restore-overview-from-snapshot

Restore global overview from a snapshot

`USAGE $ block-tools restore-overview-from-snapshot -r

 -s  [--skip-confirmation]
FLAGS
  -r, --registry=

    (required) full address of the registry
  -s, --snapshot=  (required) snapshot timestamp ID to restore from
      --skip-confirmation     skip confirmation prompt (use with caution)

DESCRIPTION Restore global overview from a snapshot`

block-tools upload-package-v1

Uploads V1 package and refreshes the registry

`USAGE $ block-tools upload-package-v1 [-r ] [-o ] [-p ] [-v ] [-m ] [-f file_path | package_name=file_path...] [--refresh]

FLAGS -f, --file=file_path | package_name=file_path... [default: ] package files -m, --meta= json file containing meta information to associate with tha package -o, --organization= target organisation -p, --package= target package -r, --registry= full address of the registry or alias from .pl.reg -v, --version= target version --[no-]refresh refresh repository after adding the package

DESCRIPTION Uploads V1 package and refreshes the registry``

npm install @platforma-sdk/block-tools

Usage

`Commands`

block-tools build-meta

Extracts meta information from blocks package.json and outputs meta.json with embedded binary and textual information linked from the meta section.

`USAGE $ block-tools build-meta -o [-i ]

FLAGS -i, --modulePath= [default: .] input module path -o, --destination= (required) output meta.json file

DESCRIPTION Extracts meta information from blocks package.json and outputs meta.json with embedded binary and textual information linked from the meta section.`

block-tools build-model

Extracts and outputs block model JSON from pre-built block model module

`USAGE $ block-tools build-model [-i ] [-b ] [-o ]

DESCRIPTION Extracts and outputs block model JSON from pre-built block model module`

block-tools list-overview-snapshots

List all available global overview snapshots in the registry

`USAGE $ block-tools list-overview-snapshots -r

 [--json]
FLAGS
  -r, --registry=

  (required) full address of the registry
      --json                output in JSON format

DESCRIPTION List all available global overview snapshots in the registry`

block-tools mark-stable

Mark target block stable

`USAGE $ block-tools mark-stable -r

 [-i ] [-v ] [--refresh] [--unmark]
FLAGS
  -i, --modulePath=         [default: .] input module path
  -r, --registry=

        (required) full address of the registry
  -v, --version-override=  override package version
      --[no-]refresh              refresh repository after adding the package
      --unmark                    reverses meaning of this command, flag can be used to remove "stable" flag from the
                                  package

DESCRIPTION Mark target block stable`

block-tools pack

Builds block pack and outputs a block pack manifest consolidating all references assets into a single folder

`USAGE $ block-tools pack [-i ] [-o ]

FLAGS -i, --modulePath= [default: .] input module path -o, --destinationPath= [default: ./block-pack] output folder

DESCRIPTION Builds block pack and outputs a block pack manifest consolidating all references assets into a single folder`

block-tools publish

Publishes the block package and refreshes the registry (for v2 block-pack schema)

`USAGE $ block-tools publish -r

 [-m ] [-v ] [--refresh] [--unstable]
FLAGS
  -m, --manifest=          [default: ./block-pack/manifest.json] manifest file path
  -r, --registry=

        (required) full address of the registry
  -v, --version-override=  override package version
      --[no-]refresh              refresh repository after adding the package
      --unstable                  do not add the published package to stable channel

DESCRIPTION Publishes the block package and refreshes the registry (for v2 block-pack schema)`

block-tools refresh-registry

Refresh overview files based on published but not proecessed artefacts

`USAGE $ block-tools refresh-registry -r

 [-m ]
FLAGS
  -m, --mode=         [default: normal] refresh mode (allowed valiues: "force", "normal", "dry-run")
  -r, --registry=

(required) full address of the registry

DESCRIPTION Refresh overview files based on published but not proecessed artefacts`

block-tools restore-overview-from-snapshot

Restore global overview from a snapshot

`USAGE $ block-tools restore-overview-from-snapshot -r

 -s  [--skip-confirmation]
FLAGS
  -r, --registry=

    (required) full address of the registry
  -s, --snapshot=  (required) snapshot timestamp ID to restore from
      --skip-confirmation     skip confirmation prompt (use with caution)

DESCRIPTION Restore global overview from a snapshot`

block-tools upload-package-v1

Uploads V1 package and refreshes the registry

`USAGE $ block-tools upload-package-v1 [-r ] [-o ] [-p ] [-v ] [-m ] [-f file_path | package_name=file_path...] [--refresh]

DESCRIPTION Uploads V1 package and refreshes the registry``

block-tools mark-stable

block-tools pack

block-tools publish

block-tools refresh-registry

block-tools restore-overview-from-snapshot

block-tools upload-package-v1

block-tools mark-stable

block-tools pack

block-tools publish

block-tools refresh-registry

block-tools restore-overview-from-snapshot

block-tools upload-package-v1

@platforma-sdk/block-tools

Table of contents

Usage

`Commands`

block-tools build-meta

block-tools build-model

block-tools list-overview-snapshots

@platforma-sdk/block-tools

Table of contents

Usage

`Commands`

block-tools build-meta

block-tools build-model

block-tools list-overview-snapshots