Rename project to docspell-cli
This commit is contained in:
@@ -1,4 +1,4 @@
|
||||
# Docspell Import
|
||||
# Docspell CLI
|
||||
|
||||
Ein Tool zum Aufräumen des Docspell-Importverzeichnisses und zum automatischen Archivieren von bestätigten Dokumenten.
|
||||
|
||||
@@ -16,23 +16,23 @@ Das Programm:
|
||||
|
||||
- [Docspell Command Line Client (dsc)](https://docspell.org/docs/tools/cli/)
|
||||
- `jq` Kommandozeilentool
|
||||
- Eine Konfigurationsdatei unter `~/docspell-import.json`
|
||||
- Eine Konfigurationsdatei unter `~/docspell-cli.json`
|
||||
|
||||
## Konfiguration
|
||||
|
||||
Erstellen Sie eine `docspell-import.json` Datei in Ihrem Home-Verzeichnis: [Beispiel-Konfiguration](./docspell-import-example.json)
|
||||
Erstellen Sie eine `docspell-cli.json` Datei in Ihrem Home-Verzeichnis: [Beispiel-Konfiguration](./docspell-cli-example.json)
|
||||
|
||||
## Read-only FUSE mount
|
||||
|
||||
The `mount` subcommand exposes a Docspell collection as a read-only filesystem.
|
||||
It uses the same `~/docspell-import.json` configuration and password command as the import command.
|
||||
It uses the same `~/docspell-cli.json` configuration and password command as the import command.
|
||||
Set `mountPath` in the config to define the default mount point and `mountQuery` to define the default Docspell query.
|
||||
|
||||
```bash
|
||||
mkdir -p ~/mnt/docspell
|
||||
docspell-import mount ~/mnt/docspell # starts in the background
|
||||
docspell-cli mount ~/mnt/docspell # starts in the background
|
||||
# or, with mountPath configured:
|
||||
docspell-import mount
|
||||
docspell-cli mount
|
||||
# unmount when done
|
||||
fusermount -u ~/mnt/docspell
|
||||
```
|
||||
@@ -54,8 +54,8 @@ The mount is read-only. File contents are downloaded lazily from `/api/v1/sec/at
|
||||
Helper commands:
|
||||
|
||||
```bash
|
||||
docspell-import get-local-path <item-id-or-web-url>
|
||||
docspell-import get-url <local-mounted-path-or-item-id>
|
||||
docspell-cli get-local-path <item-id-or-web-url>
|
||||
docspell-cli get-url <local-mounted-path-or-item-id>
|
||||
```
|
||||
|
||||
`get-local-path` starts the configured mount in the background if it is not mounted yet.
|
||||
|
||||
Reference in New Issue
Block a user