Skip to content

civex retention

Clean up by age: deleted items, change history and workflow runs. Nothing is removed unless you run it.

Command Description
forget-purged Delete the history of records that were permanently deleted.
run Remove what is older than the retention settings or than dates you give.
show Show how long each kind is kept, and what a clean-up would remove now.

civex retention forget-purged

Delete the history of records that were permanently deleted.

Permanently deleting a record now deletes every history entry about it. This does the same for records that were permanently deleted before that was so. It cannot be undone.

Usage

civex retention forget-purged [OPTIONS]

Options

Option Type Default Description
--yes, -y flag false Skip the confirmation prompt
--dry-run flag false Only count

civex retention run

Remove what is older than the retention settings or than dates you give.

Give --settings to apply the settings, and/or a date per kind (a date wins over the setting for its kind). It always counts first and asks before removing anything. History about something that can still be restored is never removed. Run civex store gc afterwards to reclaim files nothing refers to any more.

Usage

civex retention run [OPTIONS]

Options

Option Type Default Description
--settings flag false Apply the retention settings (each kind left at keep-forever is left alone)
--deleted-before str Permanently delete everything deleted before this date
--history-before str Remove change history before this date
--runs-before str Remove finished workflow runs and their logs before this date
--yes, -y flag false Skip the confirmation prompt
--dry-run flag false Only say what would be removed

civex retention show

Show how long each kind is kept, and what a clean-up would remove now.

Usage

civex retention show