Forms commands

Reference for the `revenexx forms` commands — every subcommand with a runnable example.

Auto-generated. This page is generated from the revenexx CLI by tools/sync-cli-reference.mjs. Don't edit it by hand — your changes will be overwritten.

Every revenexx forms subcommand. The example shows the required arguments; the options table lists every flag the command accepts, with a ✓ marking required flags. Some flag names carry a -_ (e.g. --attribute-_values) — that is the exact token the CLI accepts, so copy them verbatim. Run revenexx forms <command> --help for the live options.

create

Bash

revenexx forms create \
    --name Sample name \
    --slug ''

Flag	Required	Description
`--name <name>`		Human-readable form name.
`--slug <slug>`		URL-safe identifier, unique per tenant (e.g. contact, price-request).
`--definition [definition...]`		FormKit schema: an array of node objects rendered verbatim by the storefront.
`--metadata <metadata>`		Free-form metadata.
`--settings <settings>`		Submit label, success message, notify email, …
`--status <status>`		Lifecycle: draft (editing) → live (rendered by the storefront) → archived. Default 'draft'.

defaults

Bash

revenexx forms defaults

delete

Bash

revenexx forms delete \
    --id sample-id

Flag	Required	Description
`--id <id>`		—

get

Bash

revenexx forms get \
    --id sample-id

Flag	Required	Description
`--id <id>`		—

list

Bash

revenexx forms list

Flag	Required	Description
`--limit <limit>`		Page size (default 50, max 200).
`--offset <offset>`		Row offset for pagination (default 0).
`--order <order>`		Sort as 'column.asc' \| 'column.desc', e.g. 'created_at.desc'.
`--filter <column=value>`		Filter rows by column equality (repeatable).

submissions-create

Bash

revenexx forms submissions-create \
    --data '{ "key": "value" }' \
    --form-id 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d \
    --form-slug sample form slug

Flag	Required	Description
`--data <data>`		The submitted values, keyed by field name.
`--form-id <form-id>`		The form this submission belongs to.
`--form-slug <form-slug>`		Denormalised form slug for convenient filtering.
`--metadata <metadata>`		Free-form metadata.
`--source <source>`		Origin of the submission (page URL or surface).
`--status <status>`		Inbox status: new → read → archived \| spam. Default 'new'.

submissions-delete

Bash

revenexx forms submissions-delete \
    --id sample-id

Flag	Required	Description
`--id <id>`		—

submissions-get

Bash

revenexx forms submissions-get \
    --id sample-id

Flag	Required	Description
`--id <id>`		—

submissions-list

Bash

revenexx forms submissions-list

Flag	Required	Description
`--limit <limit>`		Page size (default 50, max 200).
`--offset <offset>`		Row offset for pagination (default 0).
`--order <order>`		Sort as 'column.asc' \| 'column.desc', e.g. 'created_at.desc'.
`--filter <column=value>`		Filter rows by column equality (repeatable).

submissions-prune

Bash

revenexx forms submissions-prune

Flag	Required	Description
`--dry-run [value]`		Default TRUE. Nothing is deleted until this is explicitly false.
`--form-slug <form-slug>`		Narrow the sweep to one form.
`--older-than-days <older-than-days>`		Age threshold. Omit to use the tenant's submission_retention_days. A value BELOW that setting is raised to it — the setting is the floor, not a default.
`--status <status>`		Narrow the sweep to one inbox status, e.g. 'spam'.

submissions-update

Bash

revenexx forms submissions-update \
    --id sample-id

Flag	Required	Description
`--id <id>`		—
`--data <data>`		The submitted values, keyed by field name.
`--form-id <form-id>`		The form this submission belongs to.
`--form-slug <form-slug>`		Denormalised form slug for convenient filtering.
`--metadata <metadata>`		Free-form metadata.
`--source <source>`		Origin of the submission (page URL or surface).
`--status <status>`		Inbox status: new → read → archived \| spam. Default 'new'.

update

Bash

revenexx forms update \
    --id sample-id

Flag	Required	Description
`--id <id>`		—
`--definition [definition...]`		FormKit schema: an array of node objects rendered verbatim by the storefront.
`--metadata <metadata>`		Free-form metadata.
`--name <name>`		Human-readable form name.
`--settings <settings>`		Submit label, success message, notify email, …
`--slug <slug>`		URL-safe identifier, unique per tenant (e.g. contact, price-request).
`--status <status>`		Lifecycle: draft (editing) → live (rendered by the storefront) → archived. Default 'draft'.

vocabularies-get

Bash

revenexx forms vocabularies-get \
    --name form-statuses

Flag	Required	Description
`--name <name>`		The vocabulary name — the part after the dot in the qualified id.

vocabularies-list

Bash

revenexx forms vocabularies-list

Flag	Required	Description
`--filter <column=value>`		Filter rows by column equality (repeatable).

Was this page helpful?