Skip to main content

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 \. Use [#rrggbb] for a foreground colour and [bg:#rrggbb] for a background colour. A colour applies to the prompt text that follows it; it does not colour SQL input. Quote the value because # starts a TOML comment. For example:

[cli]
prompt_format = """┌──[#bca81f][user]@[account].[role].[warehouse].[database].[schema]
[#ffff00]└─$"""

SnowSQL often puts a colour after the marker (└─$[#ffff00]). Here that trailing token is a no-op: it does not colour typed SQL. Place [#ffff00] before └─$ if you want the marker itself yellow.

Unknown bracketed tokens are dropped from the prompt and reported with a warning when the REPL starts. Prefix a colour directive with \[ to display it literally.

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.

Metadata

Release files for snowflake-cli 3.30.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for snowflake-cli 3.30.0
File Size Uploaded Provenance Actions
snowflake_cli-3.30.0.tar.gz 3.3 MB Without provenance Details for snowflake_cli-3.30.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for snowflake-cli 3.30.0
File Interpreter ABI Platform Actions
snowflake_cli-3.30.0-py3-none-any.whl Python 3 none any Details for snowflake_cli-3.30.0-py3-none-any.whl

Total release size: 4.4 MB

Release files / snowflake_cli-3.30.0.tar.gz

Download URL snowflake_cli-3.30.0.tar.gz
Size 3.3 MB
Tags Source
SHA-256 checksum
How to use checksums
329709299ff59564dd87feeff73585fcbfff167a2907ca89abb48bb31d24ce17
BLAKE2b-256 checksum
How to use checksums
f035b2e4adc55a927bd64db589ce72a793089e53b1399d09c3a4a33c79293720
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.8

Release files / snowflake_cli-3.30.0-py3-none-any.whl

Download URL snowflake_cli-3.30.0-py3-none-any.whl
Size 1.1 MB
Tags Python 3
SHA-256 checksum
How to use checksums
dcd2e3a9c53b8e58011525c4f0ec7eabd65742000b5d28de58789375b7444e5a
BLAKE2b-256 checksum
How to use checksums
7b15c580eae9c3f6afbc9c82366a895fc11b2e51e09a45efc0ff51a37b6d63d1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.8

Security for snowflake-cli 3.30.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

3.30.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page