Command line reference

The vk command line automates administrative and document functions through the REST API — for scripts, migrations and operations. It is provided as a .NET tool (obtain it from your vendor); output appears as tables, or machine-readable with --json. The CLI’s message texts are deliberately always English, so that script output stays stable.

Configuration and authentication

Every value is resolved in this order: command argument → environment variable → ~/.velkaris/config.json → default.

Option (global)	Environment variable	Meaning
`--url`	`VK_URL`	Server URL (default `http://localhost:5050`)
`--tenant`	`VK_TENANT`	Tenant code
`--token`	`VK_TOKEN`	JWT (from `vk auth login`)
`--api-key`	`VK_API_KEY`	Tenant API key
`--system-api-key`	`VK_SYSTEM_API_KEY`	System API key (for `tenant`, `cleanup`)
`--json`	—	Output as JSON

# Sign in — stores the token, tenant and URL in ~/.velkaris/config.json
vk auth login --url https://redact.example.com --tenant acme --username admin --password "…"

# Check the service status (without signing in)
vk health --url https://redact.example.com

Command groups

Tenants and users

Command	Purpose
`vk tenant create/get/update/ensure`	Create and maintain tenants (`--name`, `--slug`, `--active`); `ensure` is idempotent. Requires the system API key
`vk user list/create/get/update/delete/ensure`	Manage users (`--username`, `--password`, `--email`, `--super-admin`, `--active`)
`vk user bootstrap`	Create the first superadmin without signing in — works only while the tenant has no users yet
`vk group …`	Groups, including `members`, `add-member`, `remove-member`

Projects, folders, documents

Command	Purpose
`vk project list/create/get/update/delete/ensure`	Projects; the deletion policy through `--policy` (`NeverDelete` \| `RetentionPeriod` \| `ImmediateWithAudit`) and `--retention-days`
`vk project reindex <id>`	Rebuild the project’s search index
`vk project stats <id>`	Project statistics
`vk folder create/get/content/root/rename/delete/ensure`	Folders; `ensure` matches by name within the parent folder
`vk doc upload <file> --project-id --folder-id`	Upload a document
`vk doc download <id> --output [--version]`	Download
`vk doc get/versions/create-version/move/rename`	Metadata and versions
`vk doc delete/restore/list-deleted/permanent-delete`	The recycle bin cycle
`vk doc checkout/checkin/force-checkin/lock`	Locking (check-out and check-in)
`vk doc-history list <id>`	Change history (`--action-type`, `--skip`, `--take`)
`vk doc-link create/list/delete`	Document links
`vk alias create/list/delete`	Document aliases in further folders

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

Search, tags, metadata

Command	Purpose
`vk search --project-id --query "…"`	Full-text search. `--project-id` is mandatory, and the term is passed through `--query`. Filters include `--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`	Saved searches (including `--shared`)
`vk tag list/create/update/delete/assign/unassign/list-by-doc/ensure`	Tags (`--color`, default `#2196F3`)
`vk metadata create-def/list-defs/delete-def/set-value/get-values`	Metadata fields (`--field-type String\|Integer\|Decimal\|Date\|Boolean`)

Permissions and compliance

Command	Purpose
`vk role list/create/update/delete`	Roles with permission flags (`--can-read`, `--can-upload`, …, `--download-level 0–3`)
`vk permission set/list/delete`	Access grants: principal (user/group) × scope (project/folder/tag) → role
`vk audit list / list-by-entity`	Query the audit log
`vk legal-hold set/release/list`	Legal holds
`vk gdpr mark/get/unmark/request-delete/list-requests/update-request`	GDPR marking and deletion requests
`vk comment add/list/update/delete`	Document comments
`vk apikey list/create/get/update/delete`	Tenant API keys (`--expires`)
`vk cleanup demo-sessions [--dry-run] [--yes]`	Maintenance: delete expired demo sessions (system API key)