SBT Command References

Use sbt --help for more details about using all the commands. See below for summary of commands.

Command

Description

Helper Commands

Setup your project and dev env

init

Create shell SBT project

init-env

Interactively setup project config

check-conn

Validate configuration works

App Development Commands

Build, run and test apps

run-model

Run a locally defined model

deploy-model

Deploy a model to a configured SF environment

validate-model

Run schema validation on single model output

run-app

Run full app, all models in order

deploy-app

Deploy all models to target SF environment

validate-app

Run schema validation on all model outputs and sources

validate-source

Run schema validation against a source table

run-helper

Execute helper query in isolation to see results

Insight Cloud Commands

Communicate with the IC ecosystem

me

Check user profile in Insight Cloud backend

ping

Ping insight Cloud backend healthcheck

upload-app

Upload a new version of an app

publish-app

Publish a specific version of an app

install-app

Automatically install an app into a test org

full-rebuild

Upload, publish, and install all in one

lookup-app

Find known versions of an app

Building and publishing apps

  • SBT Beta apps: sbt build-app --app-name <name> --beta: builds an app on the legacy framework. Existing Beta apps keep working; the --beta flag marks them as legacy apps.

  • SBT 1.0 apps: sbt build-app --app-name <name>: builds on the new framework.

  • sbt cloud ping (both frameworks). Verify connectivity to Insight Cloud.

  • ⚠️ Deprecated with SBT 1.0: deploy_app and run --target snowflake.

Target-name suffixing (SBT 1.0.6+)

To prevent local runs from overwriting production objects, run-model, deploy-model, run-app, and deploy-app append _test to target names by default.

  • --suffix <value>: use a custom suffix instead of _test

  • --no-suffix: target production names. Use with care.

Known issue with mapping model targets on SBT 1.0.7; see Known Issues & How to Report a Problem.

Installs (SBT 1.0.8+)

App installs complete immediately on success. The install status wizard was removed.

Related articles

Running with overrides (advanced)

To override default source or parameter values at runtime, add [overrides.myname.sources] and [overrides.myname.params] blocks to your sbtconf.toml, then pass --overrides myname to sbt run commands.

[overrides.myname.sources]
'source.table' = 'mydatabase.myschema.mytable'

Warning: because override keys contain a period, wrap the key in quotes in the TOML file, as shown above.