livingdocs-server CLI

Livingdocs provides a powerful server CLI where you can execute maintenance and administration tasks.

To execute a livingdocs-server CLI command, go to your livingdocs server folder and

  • run npx livingdocs-server to get help for all available commands (see the list below)
  • run npx livingdocs-server <command> to get help for a specific command
CommandDescription
cleanup-documentsTruncate stale revisions, publications and metadata.
cleanup-migrationsTruncate accepted migrations.
cleanup-metadataTruncate metadata with no reference to documents or publications.
data-migration-runExecute a data migration (create/prepare/accept)
databasePostgres database actions
design-addUpload a design to the design server
design-set-activeSet active design version of a project
elasticsearch-delete-indexDelete Elasticsearch index
elasticsearch-indexIndex documents into Elasticsearch
migrateExecute database migrations
parse-channel-config-v1-to-v2Parse a channel-config from v1(deprecated) to v2
project-seedSetup multiple projects with a seed configuration
project-deleteDelete a project
project-truncateTruncate documents/events
redis-flushdbFlush Redis DB
revision-migrationMigrate document revisions
testExecute livingdocs tests
transform-to-configurable-channelTransform a static channel to a configurable channel
user-assign-groupAssign a user to a group in a project
user-create-adminCreate an admin user
user-create-adminsCreate admin users
secret-addAdd a secret and optionally update the project config with it
secret-reencryptRe-encrypt all secrets with the configured encryption key
key-generateGenerate a signing or encryption json web key
completiongenerate completion script for livingdocs-server CLI