Installing Snowflake CLI¶
This topic explains how to install Snowflake CLI on all supported platforms.
Requirements¶
Before using Snowflake CLI, you must have a valid Snowflake account.
To run Streamlit in Snowflake using Snowflake CLI, you must have a Snowflake account with permission to use Streamlit.
To run Snowpark Container Services in Snowflake using Snowflake CLI, you must have a Snowflake account with privileges to use Snowpark Container Services.
Install Snowflake CLI using package managers¶
To install Snowflake CLI using package managers, use one of the following procedures:
How to install Snowflake CLI using pip (PyPi)¶
Note
This method modifies the Python environment where you install Snowflake CLI. Consider using pipx instead to avoid dependency conflicts.
To install Snowflake CLI using pip, you must have Python version 3.8 or later installed.
Run the following shell command:
pip install snowflake-cli-labs
To verify that the software was installed successfully, run the following command:
snow --helpUsage: snow [OPTIONS] COMMAND [ARGS]... Snowflake CLI tool for developers. ╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ │ --version Shows version of the |sf-cli| │ │ --info Shows information about the |sf-cli| │ │ --config-file FILE Specifies |sf-cli| configuration file that should be used [default: None] │ │ --help -h Show this message and exit. │ ╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ ╭─ Commands ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ │ app Manage Native Apps in Snowflake │ │ connection Manages connections to Snowflake. │ │ object Manages Snowflake objects like warehouses and stages │ │ snowpark Manage procedures and functions. │ │ spcs Manages Snowpark Container Services compute pools, services, image registries, and image repositories. │ │ sql Executes Snowflake query. │ │ streamlit Manages Streamlit in Snowflake. │ ╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
How to install Snowflake CLI using pipx¶
pipx provides an alternative to pip that installs and executes Python packages into isolated virtual environments. Installing Snowflake CLI with pipx does not, therefore, modify your current Python environment.
To install Snowflake CLI using pipx, you must have pipx installed.
Run the following shell command:
pipx install snowflake-cli-labs
To verify that the software was installed successfully, run the following command:
snow --helpUsage: snow [OPTIONS] COMMAND [ARGS]... Snowflake CLI tool for developers. ╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ │ --version Shows version of the |sf-cli| │ │ --info Shows information about the |sf-cli| │ │ --config-file FILE Specifies |sf-cli| configuration file that should be used [default: None] │ │ --help -h Show this message and exit. │ ╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ ╭─ Commands ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ │ app Manage Native Apps in Snowflake │ │ connection Manages connections to Snowflake. │ │ object Manages Snowflake objects like warehouses and stages │ │ snowpark Manage procedures and functions. │ │ spcs Manages Snowpark Container Services compute pools, services, image registries, and image repositories. │ │ sql Executes Snowflake query. │ │ streamlit Manages Streamlit in Snowflake. │ ╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯