Command Line#

The urljsf command line interface (CLI) is appropriate for standalone forms, such as to be hosted on GitLab pages.

Some additional advanced options are available.

Note

For more complex use cases, please consider using the sphinx extension.

Usage#

Standalone CLI for building URL forms.

usage: urljsf [-o OUTPUT_DIR] [-h HTML_FILENAME] [--html-title HTML_TITLE]
              [--template TEMPLATE] [--help] [--version]
              INPUT

Positional Arguments#

INPUT

a urljsf definition file as JSON, TOML, or YAML

Named Arguments#

-o, --output-dir

path to a folder to generate

Default: _urljsf_output

-h, --html-filename

name of an HTML file to generate

Default: 'index.html'

--html-title

HTML page title

--template

name of the template to use

Default: 'urljsf/standalone.j2'

--version

show program’s version number and exit