Skip to content

docs: update snowflake cli installation instruction #293

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 24, 2025
Merged

docs: update snowflake cli installation instruction #293

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 5 additions & 23 deletions src/content/docs/snowflake/integrations/snow-cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,38 +3,20 @@ title: Snowflake CLI
description: Use Snowflake CLI to interact with the Snowflake emulator.
---

import { Tabs, TabItem } from '@astrojs/starlight/components';

## Introduction

Snowflake CLI is a command-line interface (CLI) for Snowflake. You can use Snowflake CLI to interact with the Snowflake emulator. Snowflake CLI provides a set of commands to manage and interact with Snowflake accounts, databases, warehouses, and more.

You can connect Snowflake CLI to the Snowflake emulator using a connection profile. A connection profile is a set of parameters that define the connection to a Snowflake account. You can create, list, and test connection profiles using Snowflake CLI.

## Installation

You can install Snowflake CLI using the following methods:

<Tabs>
<TabItem label="PyPI">
```bash
pip install snowflake-cli-labs
snow --help
```
</TabItem>
<TabItem label="Homebrew">
```bash
brew tap Snowflake-Labs/snowflake-cli
brew install snowcli
snow --help
```
</TabItem>
</Tabs>

## Configuring Snowflake CLI

In this guide, you will learn how to configure Snowflake CLI to interact with the Snowflake emulator using a `localstack` connection profile.

:::note
For installation instructions, follow the [official Snowflake documentation](https://docs.snowflake.com/en/developer-guide/snowflake-cli/installation/installation) for your operating system. This ensures you install the correct and most up-to-date version of the Snowflake CLI.
:::

### Create a connection profile

To configure Snowflake CLI to interact with the Snowflake emulator, create a connection profile using the following command:
Expand All @@ -50,7 +32,7 @@ snow connection add \

You might be prompted to enter more optional parameters, such as the connection port, database name, warehouse name, authentication method, and more. These are however optional and can be skipped.
Copy link

@mmaureenliu mmaureenliu Oct 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might worth making this a standout note - I missed it initially and got a bit baffled by all the optional params.


After a successful configuration, you can the `localstack` connection profile is ready to use.
After a successful configuration, the `localstack` connection profile is ready to use.

### List your connection profiles

Expand Down