CLI Documentation

If you are looking for information on a specific command, option, or argument, this part of the documentation covers in more details the command line interface of Rost.

Invocation

$ rost [...]

You can also invoke the command through the Python interpreter from the command line:

$ python3 -m rost [...]

Commands

rost

A simple static site generator based on Jinja2 with a CLI build using Click.

rost [OPTIONS] COMMAND [ARGS]...

Options

-v, --version: Show the version and exit.

build

Build the project.

rost build [OPTIONS]

Options

--searchpath <searchpath>

The directory to look in for templates.

Default: templates/

--outputpath <outputpath>

The directory to place rendered files in.

Default: dist/

--staticpath <staticpaths>

The directory (or directories) within searchpath where static files (such as CSS and JavaScript) are stored.

Default: static/

--log-level <log_level>: The log level for the package level logger.

--log-file <log_file>: If set will log to a file rather that stderr.

watch

Start a development server and re-build the project on change.

rost watch [OPTIONS]

Options

--searchpath <searchpath>

The directory to look in for templates.

Default: templates/

--outputpath <outputpath>

The directory to place rendered files in.

Default: dist/

--staticpath <staticpaths>

The directory (or directories) within searchpath where static files (such as CSS and JavaScript) are stored.

Default: static/

-b, --bind <bind>

The address to which the server should bind.

Default: localhost

-p, --port <port>

The port to which the server should lissen.

Default: 8080

--livereload, --no-livereload

If set will start a livereload server.

Default: False

--log-level <log_level>: The log level for the package level logger.

--log-file <log_file>: If set will log to a file rather that stderr.