CLI Documentation#

This documentation is automatically generated from the code using sphinx-click.

cookiecutter-autodoc#

cookiecutter-autodoc [OPTIONS] COMMAND [ARGS]...

Options

--show-completion#: Show completion for the current shell, to copy it or customize the installation.

Generate a cookiecutter.desc, cookiecutter.json or markdown.

cookiecutter-autodoc generate [OPTIONS] COMMAND [ARGS]...

Generate a new or update an existing cookiecutter.json file from a cookiecutter.desc.

cookiecutter-autodoc generate cookiecutter [OPTIONS]

Options

-i, --input <cookiecutter_desc>#: Required Path to a cookiecutter.desc file to read.

-o, --output <cookiecutter_json>#: Required Path to the cookiecutter.json file. If the file exists, it will be updated in place.

Generate a new or update an existing cookiecutter.desc from a cookiecutter.json file.

cookiecutter-autodoc generate desc [OPTIONS]

Options

-i, --input <cookiecutter_json>#: Required Path to the cookiecutter.json file

-o, --output <cookiecutter_desc>#: Required Path to a cookiecutter.desc file to write. If the file exists, it will be updated in place.

Generate a Markdown table describing the cookiecutter’s parameters from a cookiecutter.desc.

cookiecutter-autodoc generate markdown [OPTIONS]

Options

-i, --input <cookiecutter_desc>#: Required Path to a cookiecutter.desc file to read.

-o, --outfile <markdown_file>#: File to write the markdown table to. If blank, will output to stdout

-t, --template <markdown_template>#: Template to use for writing the markdown table. If blank, will use the default template.

cookiecutter-autodoc validate [OPTIONS] COOKIECUTTER_DESC COOKIECUTTER_JSON

Options

--allow-empty-description, --no-allow-empty-description#

Allow empty descriptions. If not set, an empty description will cause an error.

Arguments