From 6e53b0cf511a738d71b91afa6dca3690817adefa Mon Sep 17 00:00:00 2001 From: Jan Bader Date: Fri, 3 Jan 2025 00:29:32 +0100 Subject: [PATCH] doc: add readme --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..1179249 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# Docspell Consumedir Cleaner + +Ein Tool zum Aufräumen des Docspell-Importverzeichnisses und zum automatischen Archivieren von bestätigten Dokumenten. + +## Funktionsweise + +Das Programm: +- Überprüft Dateien in konfigurierten Import-Verzeichnissen +- Prüft für jede Datei, ob sie bereits in Docspell existiert +- Wenn die Datei existiert und bestätigt ist: + - Verschiebt sie in ein Archiv-Verzeichnis + - Organisiert sie nach Datum und Ordnerstruktur +- Optional: Lädt noch nicht existierende Dateien automatisch nach Docspell hoch + +## Voraussetzungen + +- [Docspell Command Line Client (dsc)](https://docspell.org/docs/tools/cli/) +- `jq` Kommandozeilentool +- Eine Konfigurationsdatei unter `~/docspell-import.json` + +## Konfiguration + +Erstellen Sie eine `docspell-import.json` Datei in Ihrem Home-Verzeichnis: