CLI Setup
Minimum System Requirements
The 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.
- 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
Installation Prerequisites
- Install Node.js version 18.x
- Clone the repository connected to your Coalesce account into your home directory. There are different ways to accomplish this, review your provider for more.
Windows
Before installing, you'll need to install git. You can download git from https://gitforwindows.org/.
Installation
To install Coalesce CLI globally, run: npm install -g @coalescesoftware/coa
. If you need to update run,npm upgrade -g @coalescesoftware/coa
.
Generate 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 calledconfig
within it. You will be populating this file in Set up Your Configuration File.
Set up Your Configuration File
Copy and paste the following information into your .coa
file. Fill in the information based on your Snowflake instance.
The [default]
will be the default Snowflake profile used. To add more profiles, add them under the default in the same format. In the example, there is a [default]
and [testing]
profiles added.
[default]
token=yourtoken
snowflakeAuthType=Basic or KeyPair
snowflakePassword=password
snowflakeKeyPairKey=path to the file containing the key (if using KeyPair)
snowflakeKeyPairPass=private key passphrase (if using KeyPair and if applicable)
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
snowflakeKeyPairKey=path to the file containing the key (if using KeyPair)
snowflakeKeyPairPass=private key passphrase (if using KeyPair and if applicable)
snowflakeRole=SYSADMIN (or other role)
snowflakeUsername=username
snowflakeWarehouse=COMPUTE_WH
environmentID=one of your non-dev environments
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
Authentication
The CLI stores basic authentication credentials locally.
Updated about 1 month ago
Now that your coa
is setup, visit the commands to learn how to use the coa
to plan, deploy, and refresh from the CLI.