describe
engine-dmo describe: Describe the project, a content type, the field types, a route or a template, with ids, as text or --json. Every subcommand, argument and flag.
Describe the project, a content type, the field types, a route or a template, with ids, as text or --json.
describe project and describe type read the project without its secrets, so they run with DATABASE_URL and SIGNING_KEY unset. describe template loads the whole configuration and needs every variable set; describe route also connects to the database. See Commands and the environment.
describe type on a core type lists the core fields (marked core) and the fields your config/schema/<type>.yaml adds. describe project lists every module the bundle compiles as enabled, such as portal /members, both on engine-dmo; turn a module’s feature off in its own configuration (for the portal, portal.mode: "off" in the portal files).
| Command | What it does |
|---|---|
engine-dmo describe fieldtypes | Every field type, what it stores, its parameters and its default translate mode |
engine-dmo describe project | Networks, sites, locales, types, routes, endpoints, reports, tiers, partner roles and staff roles, with their ids |
engine-dmo describe route | Which route answers a path, the template the site’s chain resolved, and the whole template context with real values |
engine-dmo describe template | A template’s file along the site’s chain, what it extends and includes, the type it renders and the contract it is checked against |
engine-dmo describe type | A content type’s fields at every depth with ids, types, params, groups, blocks, options, sites and member rules |
engine-dmo describe fieldtypes
Every field type, what it stores, its parameters and its default translate mode.
engine-dmo describe fieldtypes --json prints the command’s own JSON document. Needs no project.
engine-dmo describe project
Networks, sites, locales, types, routes, endpoints, reports, tiers, partner roles and staff roles, with their ids.
engine-dmo describe project --json prints the command’s own JSON document. Runs in a project.
engine-dmo describe route
Which route answers a path, the template the site’s chain resolved, and the whole template context with real values.
engine-dmo describe route <path> [flags] | Argument | Required | Repeatable |
|---|---|---|
path | yes | no |
| Flag | Type | Default | Meaning |
|---|---|---|---|
--host | string | the Host the request carries (default: the site’s first domain, or the locale’s under the domain strategy) | |
--locale | string | locale code; the path is then the unprefixed URI and the locale’s prefix or domain is added | |
--site | string | site key (default: the default site) |
--json prints the command’s own JSON document. Runs in a project.
engine-dmo describe template
A template’s file along the site’s chain, what it extends and includes, the type it renders and the contract it is checked against.
engine-dmo describe template <name> [flags] | Argument | Required | Repeatable |
|---|---|---|
name | yes | no |
| Flag | Type | Default | Meaning |
|---|---|---|---|
--site | string | site key (default: the default site) |
--json prints the command’s own JSON document. Runs in a project.
engine-dmo describe type
A content type’s fields at every depth with ids, types, params, groups, blocks, options, sites and member rules.
engine-dmo describe type <key> | Argument | Required | Repeatable |
|---|---|---|
key | yes | no |
--json prints the command’s own JSON document. Runs in a project.