CLI reference

Generated from the civex command tree, so it always matches the installed version. Run any command with --help for the same information in your terminal.

Command groups

Group	Commands	Description
`civex ai`	5	Configure the AI assistant
`civex automation`	10	Manage automated workflow processing
`civex collection`	9	Manage collections (named containers for studies or investigations)
`civex db`	9	Database management commands.
`civex files`	7	Reach stored files by name and folder, the way the records are arranged
`civex history`	6	See what changed, and when, and undo a change to a record. Entry ids are the short ones listed here.
`civex plugin`	2	Inspect available workflow plugins
`civex policy`	2	View this project's data/governance policy documents.
`civex record`	10	Manage records
`civex retention`	3	Clean up by age: deleted items, change history and workflow runs. Nothing is removed unless you run it.
`civex schema`	16	Manage schemas (data structure definitions)
`civex store`	13	Manage file storage volumes
`civex sync`	19	Keep this project in step with an authority: another civex that holds the project's shared copy.
`civex trash`	2	Browse and manage soft-deleted schemas, collections and records (Recently Deleted)
`civex view`	1	Export saved views
`civex workflow`	2	Manage and run data processing workflows

Top-level commands

Command	Description
`civex clone`	Make a new project that is a copy of an authority's, and keep it in step.
`civex demo`	Create a demo project pre-populated with example schemas and records.
`civex desktop`	Open civex in a window of its own, with a project picker.
`civex doctor`	Check this civex install and, inside a project, its data.
`civex dump`	Export all schemas, datasets, records, and workflows to a YAML file.
`civex init`	Initialize a new civex project in the given directory.
`civex license`	Print civex's software license.
`civex resolve`	Identify a resource (schema, dataset, or record) by UUID or prefix.
`civex restore`	Restore schemas, datasets, records, and workflows from a dump file.
`civex serve`	Start the civex HTTP API server.
`civex shell`	Start an interactive civex shell (no 'civex' prefix needed).
`civex shortcut`	Put a Desktop shortcut that starts civex for this project and opens it.
`civex update`	Update civex to the latest release.