Skip to main content

Command line interface

Version: 2.0.5

Command

storm

Synopsis

The storm command line tool for working with the Storm DSL.

To export information to the docs site, use the following commands:
    
    - name: Generate dsl-cli.json
    run: storm -d cli > ../storm-doc/static/json/dsl-cli.json
    
    - name: Generate dsl-classes.json
    run: storm -d classes > ../storm-doc/static/json/dsl-classes.json

Options

Names
Default value
Type
-v,--version
---
Flag

Print the version and exit.

-d,--docinfo
---
Choice

Print documantation info to JSON.

# Choices
    classes
    cli
--help
---
Flag

Show this message and exit.

Command

storm classes

Synopsis

Display the classes.

Shows the attributes of classes in the DSL in a web page or as markdown.

Options

Names
Default value
Type
-f,--fmt,--format
html
Choice

The output format. Write a Markdown file or show an HTML page. If you want to export classes documentation in pure JSON format, use storm -d classes instead of this command.

# Choices
    markdown
    html
--help
---
Flag

Show this message and exit.

Command

storm serialize

Synopsis

Serialize an example job to JSON or YaML. The structure of the serialized job is an object with two properties: nodes and edges. Nodes hold information about the tasks to run, files to upload, and so on. Edges comprise of a source and target node label and as such define the connectivity of the graph. This structure is easy to understand and can be deserializes back into a graph in memory.

Examples:

# To serialize the "frames" example and write it to stdout as pretty-printed json.
    storm serialize -f pretty -x frames
    
    # Output json to the file ~/Desktop/frames.json for visualization.
    storm serialize -f json -x frames ~/Desktop

Arguments

Name
Default value
Argument type
output
---
Path (directory)

Options

Names
Default value
Type
-f,--fmt,--format
json
Choice

The output format. JSON and YAML are implemented. Pretty is a pretty-printed JSON.

# Choices
    json
    pretty
    yaml
-x,--example
all
Choice

The example job to serialize. The examples are in the storm/examples folder. The examples are python modules that contain a function called get_job that returns a job object.

# Choices
    ass_comp_light
    all_types_job
    ass_comp_normal
    sim_job
    simple_qt
    one_task
    ass_export
    frames
    ass_comp_heavy
    all
--help
---
Flag

Show this message and exit.

Command

storm validate

Synopsis

Validate a JSON file.

Example:

storm validate /path/to/file.json

Arguments

Name
Default value
Argument type
infile
---
Path (path)

Options

Names
Default value
Type
-f,--fmt,--format
html
Choice

The output format. HTML is the default and opens a browser window. Markdown is printed to the console.

# Choices
    markdown
    html
--help
---
Flag

Show this message and exit.