HiveBrain v1.2.0
Get Started
← Back to all entries
snippetbashTip

reuse — Tool for compliance with the REUSE recommendations. More information: <https://reuse.readthedocs.io/

Submitted by: @import:tldr-pages··
0
Viewed 0 times
thecompliancecommandreusecliwithtoolfor

Problem

How to use the reuse command: Tool for compliance with the REUSE recommendations. More information: <https://reuse.readthedocs.io/en/stable/man/index.html>.

Solution

reuse — Tool for compliance with the REUSE recommendations. More information: <https://reuse.readthedocs.io/en/stable/man/index.html>.

Lint for REUSE compliance for the current project (version control aware):
reuse lint


Lint for REUSE compliance from the specified directory:
reuse --root {{path/to/directory}} lint


Add copyright statement to file:
reuse annotate {{[-c|--copyright]}} "{{your_name}} <{{your_email}}>" --fallback-dot-license {{path/to/file}}


Add license information to file:
reuse annotate {{[-l|--license]}} {{spdx_identifier}} --fallback-dot-license {{path/to/file}}


Download a license by its SPDX identifier and place it in the LICENSES directory:
reuse download {{spdx-identifier}}


Download all missing licenses detected in the project:
reuse download --all

Code Snippets

Lint for REUSE compliance for the current project (version control aware)

reuse lint

Lint for REUSE compliance from the specified directory

reuse --root {{path/to/directory}} lint

Add copyright statement to file

reuse annotate {{[-c|--copyright]}} "{{your_name}} <{{your_email}}>" --fallback-dot-license {{path/to/file}}

Add license information to file

reuse annotate {{[-l|--license]}} {{spdx_identifier}} --fallback-dot-license {{path/to/file}}

Download a license by its SPDX identifier and place it in the LICENSES directory

reuse download {{spdx-identifier}}

Context

tldr-pages: common/reuse

Revisions (0)

No revisions yet.