@hubspot/cms-cli
⚠️ This is an alpha pre-release not intended for mission-critical usage. During the alpha/beta period expect lots of changes to commands, configuration structure, and capabilities. ⚠️
Provides an hscms
command for interacting with the HubSpot CMS. Learn more about building on the HubSpot CMS.
Getting started
Installation
Using yarn
yarn add @hubspot/cms-cli --dev
Using npm
npm install @hubspot/cms-cli --save-dev
Configuration
Once the @hubspot/cms-cli
has been added to a project, a config file named hubspot.config.yml
will also be needed.
See hubspot.sample.config.yml for an example. The config can be at the project level or higher up in the directory tree.
Authentication
There are two ways that the tools can authenticate with HubSpot.
OAuth2 (recommended)
- Create a developer app
- Run
yarn hscms auth oauth2
and follow the steps
HubSpot API Key
- Set up an API key for the portal.
- Add an entry in the config file
portals:
- portalId: 123
authType: 'apikey'
apiKey: 'd1234567-123e-7890-b123-aaa80164b4cb'
Commands
Show all commands
yarn hscms help
Upload an asset using the file mapping service
yarn hscms upload --portalId=<portalId> [src] [dest]
Sync a directory of files using the file mapping service
yarn hscms sync --portalId=<portalId> [src] [dest]
Watch a directory of files and automatically upload changes
yarn hscms watch --portalId=<portalId> [src] [dest]
Create a new asset
yarn hscms create [type] [dest]
Authenticate against a portal using OAuth2
yarn hscms auth oauth2