Kommandozeilenreferenz

Die Kommandozeile vk automatisiert Verwaltungs- und Dokumentfunktionen über die REST-API — für Skripte, Migrationen und den Betrieb. Sie wird als .NET-Tool bereitgestellt (Bezug über Ihren Anbieter); die Ausgaben erscheinen als Tabellen oder mit --json maschinenlesbar. Die Meldungstexte der CLI sind bewusst immer englisch, damit Skriptausgaben stabil bleiben.

Konfiguration und Authentifizierung

Jede Angabe wird in dieser Reihenfolge aufgelöst: Befehlsargument → Umgebungsvariable → ~/.velkaris/config.json → Standardwert.

Option (global)	Umgebungsvariable	Bedeutung
`--url`	`VK_URL`	Server-URL (Standard `http://localhost:5050`)
`--tenant`	`VK_TENANT`	Mandanten-Kürzel
`--token`	`VK_TOKEN`	JWT (von `vk auth login`)
`--api-key`	`VK_API_KEY`	Mandanten-API-Schlüssel
`--system-api-key`	`VK_SYSTEM_API_KEY`	System-API-Schlüssel (für `tenant`, `cleanup`)
`--json`	—	Ausgabe als JSON

# Anmelden — speichert Token, Mandant und URL in ~/.velkaris/config.json
vk auth login --url https://redact.example.com --tenant acme --username admin --password "…"

# Diensstatus prüfen (ohne Anmeldung)
vk health --url https://redact.example.com

Befehlsgruppen

Mandanten und Benutzer

Befehl	Zweck
`vk tenant create/get/update/ensure`	Mandanten anlegen und pflegen (`--name`, `--slug`, `--active`); `ensure` ist idempotent. Benötigt den System-API-Schlüssel
`vk user list/create/get/update/delete/ensure`	Benutzer verwalten (`--username`, `--password`, `--email`, `--super-admin`, `--active`)
`vk user bootstrap`	Ersten Superadmin ohne Anmeldung anlegen — funktioniert nur, solange der Mandant noch keine Benutzer hat
`vk group …`	Gruppen inkl. `members`, `add-member`, `remove-member`

Projekte, Ordner, Dokumente

Befehl	Zweck
`vk project list/create/get/update/delete/ensure`	Projekte; Löschpolitik über `--policy` (`NeverDelete` \| `RetentionPeriod` \| `ImmediateWithAudit`) und `--retention-days`
`vk project reindex <id>`	Suchindex des Projekts neu aufbauen
`vk project stats <id>`	Projektstatistik
`vk folder create/get/content/root/rename/delete/ensure`	Ordner; `ensure` gleicht nach Name im Elternordner ab
`vk doc upload <file> --project-id --folder-id`	Dokument hochladen
`vk doc download <id> --output [--version]`	Herunterladen
`vk doc get/versions/create-version/move/rename`	Metadaten und Versionen
`vk doc delete/restore/list-deleted/permanent-delete`	Papierkorb-Zyklus
`vk doc checkout/checkin/force-checkin/lock`	Sperren (Check-out/-in)
`vk doc-history list <id>`	Änderungshistorie (`--action-type`, `--skip`, `--take`)
`vk doc-link create/list/delete`	Dokumentverknüpfungen
`vk alias create/list/delete`	Dokument-Aliase in weiteren Ordnern

vk doc upload ./vertrag.pdf --project-id 1a2… --folder-id 3c4…

Suche, Tags, Metadaten

Befehl	Zweck
`vk search --project-id --query "…"`	Volltextsuche. `--project-id` ist Pflicht, der Begriff kommt über `--query`. Filter u. a.: `--folder-id`, `--include-subfolders`, `--tag-ids`, `--tag-match-mode Any\|All`, `--date-from/--date-to`, `--mime-type`, `--min-/--max-file-size`, `--metadata key=value`, `--highlight`, `--no-fuzzy`
`vk saved-search create/list/get/update/delete/execute`	Gespeicherte Suchen (auch `--shared`)
`vk tag list/create/update/delete/assign/unassign/list-by-doc/ensure`	Tags (`--color`, Standard `#2196F3`)
`vk metadata create-def/list-defs/delete-def/set-value/get-values`	Metadatenfelder (`--field-type String\|Integer\|Decimal\|Date\|Boolean`)

Rechte und Compliance

Befehl	Zweck
`vk role list/create/update/delete`	Rollen mit Rechte-Flags (`--can-read`, `--can-upload`, … , `--download-level 0–3`)
`vk permission set/list/delete`	Zugriffs-Grants: Prinzipal (User/Group) × Geltungsbereich (Project/Folder/Tag) → Rolle
`vk audit list / list-by-entity`	Audit-Log abfragen
`vk legal-hold set/release/list`	Legal Holds
`vk gdpr mark/get/unmark/request-delete/list-requests/update-request`	DSGVO-Kennzeichnung und Löschanträge
`vk comment add/list/update/delete`	Dokumentkommentare
`vk apikey list/create/get/update/delete`	Mandanten-API-Schlüssel (`--expires`)
`vk cleanup demo-sessions [--dry-run] [--yes]`	Wartung: abgelaufene Demo-Sitzungen löschen (System-API-Schlüssel)