apiome classes
Global options such as --base-url, --tenant and --json go before the command — see CLI reference. Exit codes are listed in Exit codes.
apiome classes
List a version's classes and create new ones.
apiome classes [OPTIONS] COMMAND [ARGS]...
apiome classes create
Create a class in a draft version, with its properties and tags (POST /v1/classes/{tenant}).
On a terminal, missing fields are asked for. Properties must exist, unless --create-missing.
A published or frozen version exits 6; field problems exit 7.
If attaching a property or tag fails, the class is deleted again (exit 1).
apiome classes create [OPTIONS] PROJECT VERSION
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
PROJECT_REF | text | yes | Project slug or UUID. |
VERSION_REF | text | yes | Draft version: label (±v), UUID or tag. |
Options
| Option | Type | Default | Required | Description |
|---|---|---|---|---|
--name | text | Class name (unique in the version). | ||
--description | text | What the class represents. | ||
--tag | text (repeatable) | A project tag (repeatable); created if missing. | ||
--property | text (repeatable) | A project property, name or name:required (repeatable). | ||
--from-file | path | JSON or YAML class spec: name, description, tags, properties. | ||
--create-missing | flag | Create missing properties, asking for each one's primitive (terminal only). | ||
--yes, -y | flag | Skip the final question the prompts ask. |
apiome classes list
List a version's classes with their property count, tags and description.
--with-properties adds each class's properties (name, type, required), nested ones indented.
--json prints the classes exactly as the API returns them (after the filters and --limit).
apiome classes list [OPTIONS] PROJECT VERSION
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
PROJECT_REF | text | yes | Project slug or UUID. |
VERSION_REF | text | yes | Version label (2.1.0 or v2.1.0), UUID or tag. |
Options
| Option | Type | Default | Required | Description |
|---|---|---|---|---|
--tag | text | Only classes with this tag (any case). | ||
--search | text | Case-insensitive text in the name or description. | ||
--with-properties | flag | Show every class's properties (one call for the whole version). | ||
--limit | integer range | 50 | Show at most this many classes. | |
--all | flag | Show every match (ignores --limit). |