Skip to content

Repository files navigation

Code quality checks Integration testing CLI Action testing

Snowflake CLI

Snowflake CLI is an open-source command-line tool explicitly designed for developer-centric workloads in addition to SQL operations. It is a flexible and extensible tool that can accommodate modern development practices and technologies.

With Snowflake CLI, developers can create, manage, update, and view apps running on Snowflake across workloads such as Streamlit in Snowflake, the Snowflake Native App Framework, Snowpark Container Services, and Snowpark. It supports a range of Snowflake features, including user-defined functions, stored procedures, Streamlit in Snowflake, and SQL execution.

Docs: https://docs.snowflake.com/en/developer-guide/snowflake-cli-v2/index.

Quick start: https://quickstarts.snowflake.com/guide/getting-started-with-snowflake-cli

Cheatsheet: https://github.com/Snowflake-Labs/sf-cheatsheets/blob/main/snowflake-cli.md

Feel free to file an issue or submit a PR here for general cases. For official support, contact Snowflake support at: https://community.snowflake.com/s/article/How-To-Submit-a-Support-Case-in-Snowflake-Lodge

Install Snowflake CLI

Install with uv (PyPi)

We recommend installing Snowflake CLI in an isolated environment using uv. Requires Python >= 3.10

uv tool install snowflake-cli
snow --help

Or, with a single command

uvx --from snowflake-cli snow --help

Install with Homebrew (Mac only)

Requires Homebrew.

There are two ways to install Snowflake CLI via Homebrew:

Option 1 – Homebrew core formula (simpler, no tap required):

brew install snowflake-cli
snow --help

The formula is maintained by the Homebrew community and may trail the latest release.

Option 2 – Snowflake-maintained tap (recommended for latest releases):

The tap distributes a pre-built binary (cask) maintained directly by Snowflake and updated with every release. Homebrew requires you to explicitly trust third-party taps before installing casks from them:

brew tap snowflakedb/snowflake-cli
brew trust --cask snowflakedb/snowflake-cli/snowflake-cli
brew install --cask snowflake-cli
snow --help

Once trusted, future upgrades work normally: brew upgrade --cask snowflake-cli

Install from source

Requires Python >= 3.10 and git

git clone https://github.com/snowflakedb/snowflake-cli
cd snowflake-cli
# you can also do the below in an active virtual environment:
# python -m venv .venv
# source .venv/bin/activate
hatch build && pip install .
snow --version

You should now be able to run snow and get the CLI message.

Customize the SQL REPL prompt

The interactive snow sql prompt remains > unless you opt in with --prompt-format or a quoted prompt_format string in the [cli] section of config.toml. Placeholders (case-insensitive) are [user], [host], [account], [role], [warehouse], [database], [schema], and [connection] (the -c connection name). They update after USE. Example:

snow sql --prompt-format "[user]#[warehouse]@[database].[schema]> "

Missing values render as (no user), (no database), and so on. \n is a newline; \[, \], and \\ are literal [, ], and \. Unknown bracketed tokens are dropped from the prompt and reported with a warning when the REPL starts, which reserves the [...] namespace for later extensions. Colour directives ([#rrggbb], [bg:#rrggbb]) are part of that namespace, so they are dropped rather than rendered in this version.

Default output format

Commands print a table unless you pass --format. To change that default, set output_format in the [cli] section of config.toml or the SNOWFLAKE_CLI_OUTPUT_FORMAT environment variable. Allowed values are TABLE, JSON, JSON_EXT, and CSV. --format on the command line still wins.

[cli]
output_format = "JSON"

Get involved

Have a feature idea? Running into a bug? Want to contribute? We'd love to hear from you! Please open or review issues, open pull requests, or reach out to us on developers@snowflake.com

See CONTRIBUTING.md for development setup and contribution guidelines.

About

Snowflake CLI is an open-source command-line tool explicitly designed for developer-centric workloads in addition to SQL operations.

Topics

Resources

Contributing

Security policy

Stars

267 stars

Watchers

14 watching

Forks

Releases

Used by

Contributors

Languages