Set up the Nango CLI and an integration folder to develop custom integrations with Nango.

​

Install the Nango CLI

Install the Nango CLI globally:

npm install -g nango

​

Create your Nango integrations folder

All your integrations live in a folder called nango-integrations. Whether located in your main codebase or a dedicated repository, this folder should be version-controlled.

To initialize your integrations folder (e.g. at the root of your repository), run:

nango init

This creates the ./nango-integrations folder with some initial configuration and an example sync script. The nango-integrations directory looks like this:

nango-integrations/
├── .env
├── nango.yaml
├── models.ts
└── demo-github-integration # this is the integration unique ID and must match the nango.yaml entry and the integration ID in the UI
    └── syncs/
        └── github-issue-example.ts

​

Authenticate the CLI

In an .env file in ./nango-integrations, add the following environment variables:

NANGO_SECRET_KEY_PROD='<PROD-SECRET-KEY>'
NANGO_SECRET_KEY_DEV='<DEV-SECRET-KEY>'

Get your secret keys from the Environment Settings tab (toggle between the Production and Development environment in the left nav bar).

Learn more about the Nango CLI (reference) and the content of the integrations folder.