Skip to main content

​
Install the Nango CLI

Install the Nango CLI globally: 
npm install nango -g
In the folder where you want your integration folder (e.g. root of your project), run: 
nango init # Creates `./nango-integrations` with initial config

​
CLI Authentication

Add the following env vars. We recommend that you have a .env file in ./nango-integrations: 
NANGO_SECRET_KEY_PROD='<prod-secret-key>'
NANGO_SECRET_KEY_DEV='<dev-secret-key>'
Get your prod and dev secret keys from the Project Settings tab (toggle between the prod and dev environment in the left nav bar).
For self-hosting, set the NANGO_HOSTPORT env variable to http://localhost:3003 (for local development) or your instance’s URL.

​
All CLI commands & command details

Check out all CLI commands by running: 
nango
Get details about a specific command by running: 
nango [command] --help
CommandDescriptionDetails
nango initCreates the nango-integrations directory with a demo Github integration.Generates models.ts, but not the compiled .js files.
nango devNecessary to edit sync configurations and scripts.Watches the nango.yaml and sync scripts, re-generates models.ts and compiled .js files.
nango generateGenerates an sync script .ts file with initial scaffold when new syncs appear in your nango.yaml.Re-generates models.ts, not the compiled .js files.
nango dryrun <params>Lets you test sync scripts locally.
nango deploy <env>Lets you deploy your sync to your dev or prod environmentGenerates the compiled .js files.

​
Flags & environment variables

Global command flags: 
# Command flag to auto-confirm all prompts (useful for CI).
--auto-confirm
Environment variables: 
# Recommendation: in a ".env" file in ./nango-integrations.

# Authenticates the CLI (get the keys in the dashboard's Projects Settings).
NANGO_SECRET_KEY_DEV=xxxx-xxx-xxxx
NANGO_SECRET_KEY_PROD=xxxx-xxx-xxxx

# Nango's instance URL (OSS: change to http://localhost:3003 or your instance URL).
NANGO_HOSTPORT=https://api.nango.dev # Default value

# How to handle CLI upgrades ("prompt", "auto" or "ignore").
NANGO_CLI_UPGRADE_MODE=prompt # Default value

# Whether to prompt before deployments.
NANGO_DEPLOY_AUTO_CONFIRM=false # Default value