@hubspot/cli

@hubspot/cli

A CLI for HubSpot developers to enable local development and automation. Learn more about building on HubSpot.

Contributing

For more information on developing, see the Contributing Guide.

Getting started

For more information on using these tools, see Local Development Tooling: Getting Started

Installation

npm install -g @hubspot/cli

Configuring

Once the @hubspot/cli has been added to a project, a config file named hubspot.config.yml will also be needed. It is recommended that the config file is kept in your $HOME directory.

cd ~
hs init

Auto Completion

You can set up command autocompletion by running

hs completion

and copying the output to either your .bashrc or .zshrc, and then sourcing that file source ~/.bashrc source ~/.zshrc or restarting your terminal.

Commands

A full breakdown of the commands can be found on the local development tools reference page.

Note: When @hubspot/cli is installed local to a project, the commands need to be prefixed with either yarn if using yarn or npx if using npm.

Authentication

There are two ways that the tools can authenticate with HubSpot.

Personal Access Key (recommended)

1. Run hs init or hs auth personalaccesskey and follow the instructions

OAuth2

1. Create a developer app
2. Run hs auth oauth2
3. Select OAuth2 and follow the steps

Note: The Account ID used should be the Test Account ID (not the developer app ID). Client ID and Client Secret are from the developer app.

Exit Codes

The CLI will exit with one of the following exit codes:

• 0: A successful run
• 1: There was a config problem or an internal error
• 2: There are warnings or validation issues

Changelog

The best way to stay up to date is to check out the Github Releases and also follow our developer changelog posts for an easier to read breakdown of major changes.