-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
5be02a2
commit ae79220
Showing
1 changed file
with
27 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
sidebar_position: 30 | ||
--- | ||
|
||
# Common REUSE CLI Commands | ||
|
||
## Check for incompliant files (= not properly licensed) | ||
|
||
Run `pipx run reuse lint` | ||
|
||
## Add REUSE statements to a file | ||
|
||
Run `pipx run reuse annotate -c="<COPYRIGHT>" -l="<LICENSE-SPDX-IDENTIFIER>" <file>` | ||
|
||
Replace `<COPYRIGHT>` with the copyright holder, e.g "Deutsche Telekom AG", and `<LICENSE-SPDX-IDENTIFIER>` with the ID of the license the file should be under. For possible IDs see https://spdx.org/licenses/. | ||
|
||
## Add REUSE statements to a directory | ||
|
||
Run `pipx run reuse annotate -c "<COPYRIGHT>" -l "<LICENSE-SPDX-IDENTIFIER>" --recursive --skip-existing <directory>` | ||
|
||
## Add missing license texts to the repo | ||
|
||
Run `pipx run reuse download --all` to add license texts for all licenses detected in the project. | ||
|
||
## Get an SPDX file with all licensing information for this project (not for dependencies!) | ||
|
||
Run `pipx run reuse spdx` |