An open API service indexing awesome lists of open source software.

https://github.com/hubspot/hubspot-cli

A CLI for HubSpot
https://github.com/hubspot/hubspot-cli

Last synced: 3 months ago
JSON representation

A CLI for HubSpot

Awesome Lists containing this project

README

          

# @hubspot/cli

[![Official Release](https://img.shields.io/npm/v/@hubspot/cli/latest?label=Official%20Release)](https://www.npmjs.com/package/@hubspot/cli) [![Latest Beta Version](https://img.shields.io/npm/v/@hubspot/cli/next?label=Latest%20Beta%20Version)](https://www.npmjs.com/package/@hubspot/cli?activeTab=versions)

The official CLI for HubSpot developers to enable local development and automation. [Learn more about building on HubSpot](https://developers.hubspot.com).

> **📢 Repository Notice:** This repository is read-only. The HubSpot CLI has been moved to our internal GitHub organization for active development. While we continue to sync the latest changes to this public repository, all development work now happens internally. Issues can still be reported here, but pull requests will not be accepted.

Feedback about the HubSpot developer platform can be given through our [developer feedback form](https://developers.hubspot.com/feedback)

## Getting started

For more information on using these tools, see the [HubSpot CLI Docs](https://developers.hubspot.com/docs/developer-tooling/local-development/hubspot-cli/install-the-cli)

### Installation

```bash
npm install -g @hubspot/cli
```

### Configuring

Once the `@hubspot/cli` has been added to a project, the next step is to authenticate your HubSpot account

```bash
hs init
```

## Commands

A full breakdown of the commands can be found on the [local development tools reference page](https://developers.hubspot.com/docs/developer-tooling/local-development/hubspot-cli/reference).

**Note:** When `@hubspot/cli` is not installed globally, the commands need to be prefixed with either `yarn` if using `yarn` or `npx` if using `npm`.

## Changelog

The best way to stay up to date is to check out the [Github Releases](https://github.com/HubSpot/hubspot-cli/releases) or follow our [developer changelog posts](https://developers.hubspot.com/changelog) for an easier to read breakdown of major changes.