Models commands - Omni CLI

Manage models, views, fields, topics, branches, git configuration, and YAML. See the Model API documentation for more information.

omni models <command>

delete moves the model to the trash together with the workbooks, dashboards, and child extension models built on it, and requires Connection Admin. To delete a branch instead, use delete-branch.git-rotate-webhook-secret returns the new secret only in its response, so save it before moving on. The old secret stops validating immediately, so webhook deliveries fail signature verification until you set the new value in your git provider. Models that share a git repository share one secret.

Command	Description
`list`	List models, 20 per page by default
`create`	Create a model
`update`	Update model
`delete`	Move a shared or shared extension model to the trash, with its dependent content
`model-ai-agent-actions`	Get model AI agent actions
`create-branch`	Create a branch of a model
`get-views`	Get model views
`get-schemas`	List available schemas for a model
`update-view`	Update a view
`delete-view`	Delete a view
`create-field`	Create a field
`update-field`	Update a field
`delete-field`	Delete a field
`list-topics`	List topics
`get-topic`	Get a topic
`update-topic`	Update a topic
`delete-topic`	Delete a topic
`refresh`	Refresh model schema
`jobs-get-status`	Get schema refresh or dbt sync job status
`validate`	Validate a model
`migrate`	Migrate a model
`delete-branch`	Delete a branch
`branch-dbt`	Set branch dbt environment
`branch-dbt-get`	Read branch dbt environment
`dbt-sync`	Trigger a dbt metadata sync for a branch
`dbt-exposures`	Get dbt exposures
`merge-branch`	Merge a branch
`cache-reset`	Reset cache for policy
`git-get`	Get git configuration
`git-create`	Create git configuration
`git-update`	Update git configuration
`git-delete`	Delete git configuration
`git-sync`	Sync model with git
`git-rotate-signing-key`	Rotate commit signing key
`git-rotate-webhook-secret`	Rotate the pull request webhook signing secret
`commit`	Commit branch to git
`content-validator-get`	Validate content references
`content-validator-replace`	Replace content references
`yaml-get`	Get model YAML
`yaml-create`	Update model YAML
`yaml-delete`	Delete a model YAML file

# List up to 100 models (including IDs and pagination metadata)
omni models list --page-size 100 --format json

# Create a branch of a model
omni models create-branch <model-id> --name "add-new-columns"

# View help for yaml-create command, including arguments and flag details
omni models yaml-create --help

Pagination

omni models list returns one page per call, with 20 models by default. Use --page-size to request up to 100 models per page. If pageInfo.hasNextPage is true, pass pageInfo.nextCursor to --cursor to fetch the next page. Repeat until hasNextPage is false; increasing the page size alone does not fetch every model.

omni models list --page-size 100 --cursor "NEXT_CURSOR" --format json

Replace NEXT_CURSOR with the value from the previous response and keep the same filters and sort options between pages.

Every command in this group also accepts the global flags, including --token, --profile, --format, and --compact.

Getting started

Command groups

Reference

Models commands - Omni CLI

​Pagination

Pagination