Command line interface

This package provides you with a command-line script that should be invoked from anywhere within the git project you aim to manipulate the files with. I.e.

    cd <your-git-project>
    reuse-shortcuts [options] [arguments]
    # or
    python -m reuse_shortcuts [options] [arguments]

reuse-shortcuts

reuse-shortcuts [OPTIONS] SHORTCUT PATH

Options

-c, --copyright <COPYRIGHT>: Copyright holder, repeatable.

-l, --license <SPDX_IDENTIFIER>: SPDX License Identifier, repeatable.

--contributor <CONTRIBUTOR>: File contributor, repeatable.

-y, --year <YEAR>: Year of copyright notice. You may define multiple years or a range of years.

-s, --style <style>

Comment style to use.

Options:: applescript | aspx | bat | bibtex | | c | cpp | cppsingle | f | ftl | handlebars | haskell | html | jinja | julia | lean | lisp | m4 | ml | f90 | plantuml | python | rst | semicolon | tex | man | vst | vim | xquery

--copyright-prefix <copyright_prefix>

Copyright prefix to use.

Options:: spdx | spdx-c | spdx-symbol | spdx-string | spdx-string-c | spdx-string-symbol | snippet | snippet-c | snippet-symbol | snippet-string | snippet-string-c | snippet-string-symbol | string | string-c | string-symbol | symbol

-t, --template <TEMPLATE>: Name of template to use.

--exclude-year: Do not include year in copyright notice.

--merge-copyrights: Merge copyright notices if they are identical except for their years.

--single-line: Force single-line comment style.

--multi-line: Force multi-line comment style.

-r, --recursive: Add headers to all files under specified directories recursively.

--no-replace: Do not replace the first header in the file; just add a new one.

--force-dot-license: Always write a .license file instead of a header inside the file.

--fallback-dot-license: Write a .license file to files with unrecognised comment styles.

--skip-unrecognised: Skip files with unrecognised comment styles.

--skip-existing: Skip files that already contain REUSE information.

Arguments

SHORTCUT: Required argument

PATH: Optional argument(s)