MemoryViz CLI

Run MemoryViz straight from your terminal!

The MemoryViz CLI takes in MemoryViz-compatible JSON and returns an SVG of the memory model.

Usage

To use the MemoryViz CLI, run:

$ npx memory-viz <path-to-file>

where <path-to-file> is the path to a file containing MemoryViz-compatible JSON. If a file path is not provided, the CLI will take input from standard input.

You may also specify an output path using the --output option (see below). If no output path is provided, the CLI will print to standard output.

Note: The CLI currently does not support typing input directly into the terminal. Instead, use piping or other strategies to pass data into standard input.

Options

Below are optional arguments used to specify the way in which the SVG is outputed and generated.

--output=<path>

Writes generated SVG to the specified file path. The directories in the path must exist. If the file already exists, it will be overwritten.

For example, ./<filename>, <filename>, ./<dir>/<filename>, <dir>/<filename> are accepted.

--width

Specifies the width of the generated SVG.

--height

Specifies the height of the generated SVG.

--roughjs_config<arg>

Specifies the style of the generated SVG. Please refer to the Rough.js documentation for available options.

The argument is a comma-separated list of key-value pairs in the form <key1=value1,key2=value2,...>.

Examples

This takes input from a file and prints to stdout.

$ npx memory-viz <path-to-file>

This takes input from stdin, generates the SVG with a width of 200, and prints to stdout.

$ npx memory-viz --width=200

This takes input from a file, generates the SVG with a solid red fill, and writes the SVG to the specified path.

$ npx memory-viz <path-to-file> --output=<path> --roughjs-config fill=red,fillStyle=solid