1
0
Fork 0
mirror of https://github.com/tldr-pages/tldr.git synced 2025-07-04 16:55:25 +02:00
tldr/pages/common/reuse.md
the0xdev e9a31096f7
reuse: add annotate example (#16543)
Co-authored-by: Managor <42655600+Managor@users.noreply.github.com>
2025-05-24 08:48:57 +03:00

28 lines
820 B
Markdown

# 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 licence 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`