storm.pkg.gen

The Synapse storm.pkg.gen tool can be used to generate a Storm Package containing new Storm commands and Storm modules from a YAML definition and optionally push it to a Cortex or PkgRepo.

For additional details on using the storm.pkg.gen tool see Building / Loading a Rapid Power-Up.

Syntax

storm.pkg.gen is executed using python -m synapse.tools.storm.pkg.gen. The command usage is as follows:

python -m synapse.tools.storm.pkg.gen -h

usage: synapse.tools.storm.pkg.gen [-h] [--push <url>] [--push-verify]
                                   [--save <path>] [--optic <path>]
                                   [--signas <name>] [--certdir <dir>]
                                   [--no-build] [--no-docs]
                                   <pkgfile>

A tool for generating/pushing storm packages from YAML prototypes.

positional arguments:
  <pkgfile>        Path to a storm package prototype .yaml file, or a
                   completed package .json/.yaml file.

options:
  -h, --help       show this help message and exit
  --push <url>     A telepath URL of a Cortex or PkgRepo.
  --push-verify    Tell the Cortex to verify the package signature.
  --save <path>    Save the completed package JSON to a file.
  --optic <path>   Load Optic module files from a directory.
  --signas <name>  Specify a code signing identity to use from
                   ~/.syn/certs/code.
  --certdir <dir>  Specify an alternate certdir to ~/.syn/certs.
  --no-build       Treat pkgfile argument as an already-built package
  --no-docs        Do not require docs to be present and replace any doc
                   content with empty strings.

Note

This tool was previously run using synapse.tools.genpkg. It can still be run with that name.