How do I set up the CLI?

[APTy]

How do I start using spyglass?

[spyglass-software]

Getting Started

Install the CLI using npm:

npm install -g spyglass-cli

Basic Usage

1. Authentication

To start, connect an account

spyglass accounts:auth <orgID-accountID> --check

Welcome to Spyglass! Let's set up a ~/.snowsql/config file.
(See https://docs.snowflake.com/en/user-guide/snowsql-config for more info)

Username (required): <myUsername>
Password (required): *********************
Checking connection... done
Success!

(The identifier is a combination of your Organization ID and Account ID, viewable in the Snowsight UI, e.g. zhjgixi-tv26532)

2. Import

Next, import your current Snowflake objects/roles to Spyglass YAML format.

spyglass import <orgID-accountID>

Fetching current Snowflake configuration...
Progress | ████████████████████████████████████████ | 41/41 Objects
Successfully wrote current configuration to skigdyn-wu58851.yaml.

Git Commit

You should commit this code to your repo, so that the apply step understands what changes have been made.

3. Verify

After making changes to your config, you can verify that the configuration is valid, and catch any issues, prior to applying them to Snowflake.

spyglass verify <orgID-accountID>

Verifying configuration... done

4. Apply

Apply the latest changes to Snowflake.

spyglass apply <orgID-accountID>

5. Finished!

Let us know if you have any questions or feedback!