CLI Setup

Minimum System Requirements

OS: 64-bit Windows 10, macOS 11, Linux kernel version 5.0+
Processor: AWS t2.medium vCPU or equivalent / Apple M1 / Intel Core i3-6100 / AMD Ryzen 3 1200 or better
RAM: 1GB+ RAM
Storage: 250MB+ free space
Network: Access to Snowflake Instance and Coalesce Cloud
Node Version: v18.x

The above system requirements are general guidelines and may vary depending upon the size of the Coalesce project. Projects with a large number of nodes may have higher system requirements.

Installation Prerequisites

Install Node.js version 18.x if you haven't already.

📘
Windows Users
Windows doesn't come with git installed by default, so you will need to download and install it from https://gitforwindows.org/

Installation

To install Coalesce CLI globally, run:

npm install -g @coalescesoftware/coa

To update, run:

npm upgrade -g @coalescesoftware/coa

Generating Your Token

Sign into Coalesce.
Click on the Deploy tab at the top.
Hover over Generate Access Token and copy the token that appears.

In your operating system's home directory, create a hidden folder .coa and an empty file with no extension called config within it. You will be populating this file in the next section.

Setting up Your Configuration File

Using the file you previously generated, populate it with the relevant information from your Snowflake account in the following format:

[default]
token=yourtoken
snowflakeAuthType=Basic or KeyPair
snowflakePassword=password
snowflakeRole=SYSADMIN (or other role)
snowflakeUsername=username
snowflakeWarehouse=COMPUTE_WH
environmentID=one of your non-dev environments

[testing]
token=yourtoken
snowflakeAuthType=Basic or KeyPair
snowflakePassword=password
snowflakeRole=SYSADMIN (or other role)
snowflakeUsername=username
snowflakeWarehouse=COMPUTE_WH
environmentID=one of your non-dev environments

Note the [default] will be the default Snowflake profile used, though others can be added below in the same format and loaded instead. See [testing] example above.

📘
Using Coalesce APAC region?
To point coa CLI to the correct Coalesce backend, you must set the following environment variables within your shell session.
export AXIOS_POST_ADDRESS=https://app.australia-southeast1.gcp.coalescesoftware.io
export SCHEDULER_ADDRESS=https://app.australia-southeast1.gcp.coalescesoftware.io
export RUNTIME_ENVIRONMENT=apac_production

Cloning Your Repository

Make sure to clone the repository connected to your Coalesce account into your home directory. There are many potential ways to do this, so check your git provider's documentation for needed steps. Links below are included for your convenience:

GitHub
GitLab
BitBucket
Azure DevOps