From ae7922080c693d0644d72b2cfece72fdb176e1fb Mon Sep 17 00:00:00 2001
From: Daniel Eder <daniel.eder@magenta.at>
Date: Wed, 20 Mar 2024 10:37:47 +0100
Subject: [PATCH] docs: add common commands

---
 docs/command-reference.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 docs/command-reference.md

diff --git a/docs/command-reference.md b/docs/command-reference.md
new file mode 100644
index 0000000..d725d75
--- /dev/null
+++ b/docs/command-reference.md
@@ -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`
\ No newline at end of file