CLI Commands

class helix.management.commands.install.Command

Install external dependencies.

usage: helix install [-h] [-c] [-f] [-v] {blueprints,components,transforms} ...

positional arguments:
  {blueprints,components,transforms}
    blueprints          install dependencies for blueprints
    components          install dependencies for components
    transforms          install dependencies for transforms

optional arguments:
  -h, --help            show this help message and exit
  -c, --check           check the installation status without installing anything
  -f, --fail-fast       stop installing if there are any failures
  -v, --verbose         verbose mode

class helix.management.commands.list.Command

Print details about blueprints, components, and transforms.

usage: helix list [-h] [-s SEARCH] [-d] [-y] [-t] [-c] [-r] [-v] [-vv] [-vvv] {blueprints,components,transforms} ...

positional arguments:
  {blueprints,components,transforms}
        blueprints          list blueprints
        components          list components
        transforms          list transforms

optional arguments:
  -h, --help            show this help message and exit
  -s SEARCH, --search SEARCH
                                                search with a given string
  -d, --description     include description
  -y, --type            include type
  -t, --tags            include tags
  -c, --configuration   include configuration parameters
  -r, --dependencies    include dependencies
  -v, --verbose         include description and tags
  -vv, --very-verbose   verbose plus configuration
  -vvv, --very-very-verbose
                                                very verbose plus type and dependencies

class helix.management.commands.build.Command

Build a blueprint with a set of components and transforms.

usage: helix build [-h] {blueprint,json} ...

positional arguments:
  {blueprint,json}
    blueprint       manually specify blueprint, components, and transforms
    json            build from a json configuration file

optional arguments:
  -h, --help        show this help message and exit

class helix.management.commands.datasetsimilarity.Command

Generate a dataset from a collection of Components.

usage: helix dataset-similarity [-h] [-c [COMPONENTS [COMPONENTS ...]]] [-l [file [file ...]]] [-t [TRANSFORMS [TRANSFORMS ...]]] [-s SAMPLE_COUNT]
                                [-m MAXIMUM_SAMPLES] [-n COMPONENT_COUNT] [-w WORKERS] [-v]
                                {simple,random,walk} output

positional arguments:
  {simple,random,walk}  dataset generation strategy
  output                output directory where dataset should be written

optional arguments:
  -h, --help            show this help message and exit
  -c [COMPONENTS [COMPONENTS ...]], --components [COMPONENTS [COMPONENTS ...]]
                        component(s) to include (by name)
  -l [file [file ...]], --load [file [file ...]]
                        load additional component(s) from one or more files
  -t [TRANSFORMS [TRANSFORMS ...]], --transforms [TRANSFORMS [TRANSFORMS ...]]
                        transform(s) to apply to all samples (by name)
  -s SAMPLE_COUNT, --sample-count SAMPLE_COUNT
                        number of samples to attempt to generate
  -m MAXIMUM_SAMPLES, --maximum-samples MAXIMUM_SAMPLES
                        maximum number of samples to generate
  -n COMPONENT_COUNT, --component-count COMPONENT_COUNT
                        number of components per sample
  -w WORKERS, --workers WORKERS
                        number of parallel workers to use (default: <count(CPUs)/2>)

class helix.management.commands.test.Command

Run tests.

usage: helix test [-h] {unit,system,integration} ...

positional arguments:
  {unit,system,integration}
    unit                unit tests for blueprints, components, or transforms
    system              unit tests for core helix functionality
    integration         integration tests for combinations of blueprints,
                        components, and transforms

optional arguments:
  -h, --help            show this help message and exit