civex sync
Keep this project in step with an authority: another civex that holds the project's shared copy.
| Command | Description |
|---|---|
authority |
Act as the authority for this project. |
conflicts |
List values that did not go in as made, with both sides. |
connect |
Point this project at an authority. An empty project becomes a copy of it; a project with data fills an empty authority. Two projects that both hold data are refused. |
device |
Devices allowed to follow this authority. |
disconnect |
Stop following the authority. The data here stays as it is. |
fetch |
Download every file this project's records cite that isn't on this computer yet, now, with a progress bar. Stopping (Ctrl+C) keeps what has arrived; the rest comes later. |
files |
See, per collection, how many files are on this computer and how many are not on this computer, and whether it keeps a copy here. With a mode, set the default for collections that haven't their own (civex sync keep). |
free |
Free space: remove this computer's copies of a collection's files; they are fetched again when opened or exported. Only files the server confirms it holds are removed, never one another collection kept here uses, and the collection is set to fetch files when opened. |
interval |
Set how often the background sync runs. With 'never' it syncs only when you ask (civex sync now, or Sync now in the app). |
keep |
Keep a collection's files on this computer: what is missing is downloaded in the background while civex runs (or now, with civex sync fetch). With --opened, fetch them only when opened or exported. |
library |
Share workflows and plugins through the authority: publish them from here, install them from there. Nothing arrives by itself. |
now |
Send this project's changes and bring in everyone else's. |
pause |
Stop syncing until resumed. Changes keep being recorded. |
reopen |
Take back 'keep theirs': the conflicts are open again. (Putting your value back, deleting or sending again made an edit; undo that from history instead.) |
resolve |
Settle a conflict, or with --all every open one. |
resume |
Start syncing again. |
status |
Show where this project stands with its authority. |
user |
Show or set the author name recorded on changes in this project. It is saved in this project's config.toml; the default is your operating-system user. |
watch |
Keep syncing in this terminal until stopped (Ctrl+C): after edits, on the interval, and backing off when the authority can't be reached. |
civex sync authority
Act as the authority for this project.
Usage
civex sync conflicts
List values that did not go in as made, with both sides.
Usage
Options
| Option | Type | Default | Description |
|---|---|---|---|
--all |
flag | false |
Include ones already settled. |
--record |
str |
Only those about this record (its id). |
civex sync connect
Point this project at an authority. An empty project becomes a copy of it; a project with data fills an empty authority. Two projects that both hold data are refused.
Usage
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
URL |
str |
yes | The authority's address, e.g. https://civex.example.com |
Options
| Option | Type | Default | Description |
|---|---|---|---|
--invite |
str |
The invite the authority's admin gave. Leave out when this computer has joined that address before (connecting again after a copy stopped part way). Env: CIVEX_SYNC_INVITE. |
civex sync device
Devices allowed to follow this authority.
Usage
civex sync disconnect
Stop following the authority. The data here stays as it is.
Usage
civex sync fetch
Download every file this project's records cite that isn't on this computer yet, now, with a progress bar. Stopping (Ctrl+C) keeps what has arrived; the rest comes later.
Usage
civex sync files
See, per collection, how many files are on this computer and how many are
not on this computer, and whether it keeps a copy here. With a mode, set the
default for collections that haven't their own (civex sync keep).
Usage
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
MODE |
str |
no | Set the project's default: 'all' keeps a copy of every file, 'opened' fetches a file only when it is opened or exported. Leave out to see where each collection's files are. |
civex sync free
Free space: remove this computer's copies of a collection's files; they are fetched again when opened or exported. Only files the server confirms it holds are removed, never one another collection kept here uses, and the collection is set to fetch files when opened.
Usage
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
COLLECTION |
str |
yes | The collection, by name or id. |
Options
| Option | Type | Default | Description |
|---|---|---|---|
--yes, -y |
flag | false |
Don't ask first. |
civex sync interval
Set how often the background sync runs. With 'never' it syncs only when
you ask (civex sync now, or Sync now in the app).
Usage
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
VALUE |
str |
yes | Seconds between automatic syncs, or 'never'. |
civex sync keep
Keep a collection's files on this computer: what is missing is
downloaded in the background while civex runs (or now, with civex sync
fetch). With --opened, fetch them only when opened or exported.
Usage
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
COLLECTION |
str |
yes | The collection, by name or id. |
Options
| Option | Type | Default | Description |
|---|---|---|---|
--opened |
flag | false |
Fetch its files only when opened instead. |
--reset |
flag | false |
Follow the project's default again. |
civex sync library
Share workflows and plugins through the authority: publish them from here, install them from there. Nothing arrives by itself.
Usage
civex sync now
Send this project's changes and bring in everyone else's.
Usage
civex sync pause
Stop syncing until resumed. Changes keep being recorded.
Usage
civex sync reopen
Take back 'keep theirs': the conflicts are open again. (Putting your value back, deleting or sending again made an edit; undo that from history instead.)
Usage
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
CONFLICT_IDS... |
str |
yes | The ids of conflicts settled by keeping theirs. |
civex sync resolve
Settle a conflict, or with --all every open one.
Usage
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
CONFLICT_ID |
str |
no | The conflict's id (not with --all). |
Options
| Option | Type | Default | Description |
|---|---|---|---|
--take |
str |
'theirs' keeps what the authority has; 'mine' puts your value back as a new edit; 'value' puts the one given with --value; 'delete' deletes a record that was deleted there; 'retry' sends a refused change again from the record as it is now; 'restore_above' brings back the deleted records a refused record sits under, then sends it again. (required) | |
--value |
str |
With --take value: the value to put in, as JSON (a number, true, a list, "quoted text"), or plain text. | |
--force |
flag | false |
Put your value back even though the record's value has changed again since the conflict was recorded. |
--all |
flag | false |
Settle every open conflict that offers this way (narrow it with --kind), not one. Those that don't, or fail their checks, stay open. |
--kind |
str |
With --all: only this kind (conflict, rejected or edit_vs_delete). |
civex sync resume
Start syncing again.
Usage
civex sync status
Show where this project stands with its authority.
Usage
civex sync user
Show or set the author name recorded on changes in this project. It is saved in this project's config.toml; the default is your operating-system user.
Usage
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
NAME |
str |
no | The name to record on your changes. |
Options
| Option | Type | Default | Description |
|---|---|---|---|
--reset |
flag | false |
Go back to the default. |
civex sync watch
Keep syncing in this terminal until stopped (Ctrl+C): after edits, on the interval, and backing off when the authority can't be reached.
Usage