Skip to content

civex bundle

Move a project's data to another project as one file: schemas, collections, records (their ids kept), the files they cite, and the project's workflows and plugins.

Command Description
export Write the project's data to one bundle file.
import Read a bundle into this project.
show Say what a bundle holds, without importing anything.

civex bundle export

Write the project's data to one bundle file.

A bundle is a zip holding the schemas, the collections and their records with their ids, the stored files those records cite (unless --no-files), and the project's workflows and plugins. Read it into another project with civex bundle import.

Usage

civex bundle export [OPTIONS]

Options

Option Type Default Description
--output, -o path civex-bundle.civex.zip Where to write it
--collection, -c str Only these collections' records and files (repeatable); default all
--no-files flag false Leave the stored files out (records still cite them)
--no-data flag false Structure only: no records and no files
--no-workflows flag false Leave workflows and plugins out
--dry-run flag false Say what would go in without writing anything

civex bundle import

Read a bundle into this project.

Schemas are matched by name (one already here only gains the fields it lacks), collections by name (one already here is reused), and records by id (one already here, live or deleted, is left as it is). Each record is checked and recorded in history like any other, and the whole import is one event in Activity. A record whose parent or referenced record is in neither the bundle nor this project is skipped and named.

Usage

civex bundle import [OPTIONS] BUNDLE_FILE

Arguments

Argument Type Required Description
BUNDLE_FILE path yes A bundle written by civex bundle export

Options

Option Type Default Description
--yes, -y flag false Skip the confirmation

civex bundle show

Say what a bundle holds, without importing anything.

Usage

civex bundle show BUNDLE_FILE

Arguments

Argument Type Required Description
BUNDLE_FILE path yes A bundle written by civex bundle export