Skip to main content
DocumentationLibraryReference
On this page

Kater CLI Find and understand model

kater model describe

Shows the saved contract of every model you select, as kater model show does for one model.

With no option, it shows every model in your scope. It also lists the tags that the models use, with the models that have each tag.

Examples

Terminal window
# Go to the connection's shared models
cd connections/snowflake_prod_connection/modeling
# Show the contract of every shared model
kater model describe
# Show the contracts of the models tagged for the finance team
kater model describe --select tag:team=finance
# Show the contracts of the semantic models in the marketing folder
kater model describe --select kater_objects/semantic_models/marketing

Options

OptionDescription
-s, --select <selection>Shows only the models it selects: a folder or a SQL file, a model by its name, its typed address, such as semantic.ad_reporting, or its id, or a method such as tag:team=marketing. See Selecting models. You can give it more than one time.
--exclude <selection>Leaves out the models it selects, in the same words as --select. You can give it more than one time.
--state <state>What state:modified and state:new compare with: a folder that holds an earlier manifest.json, or git:REF, such as git:main.

It also takes the global options --json, --kater-root, --scope and --help.

See also