Getting started with local development
The HubSpot CLI (Command Line Interface) connects your local workflow to HubSpot, allowing you to utilize version control, your favorite text editor and various web development technologies when developing on CMS Hub.
This guide is best for folks who are familiar already with the CMS but want to learn about working with the CLI. If you are completely new to HubSpot CMS Hub development, we encourage you to follow the quickstart guide.
The HubSpot CLI is used to
watch files from the developer file system. Building with the CLI means you'll have local copies of your assets. Because you have the code locally you can use your preferred code editor, you can use build tools, you can commit your code to a git repository.
Additionally the CLI has helper functionality that can speed up your development. For example the
hs create command gives you ways to quickly create different types of assets locally, from modules to creating a theme from the boilerplate.
In this guide, we'll walk through installing the CLI, and the core features of the CLI fetching a project from your HubSpot account, and then uploading changes back to your Design Tools.
For more commands and local file formats, see the Local Development Tooling Reference.
To use the local tooling, you'll need to:
- To install the HubSpot tools globally, run npm install -g @hubspot/cli in your command line. To install the tools in your current directory, run npm install @hubspot/cli.
If you prefer, you can also use Yarn. Homebrew is not required but recommended for easy installation. If you are using Yarn, commands are run with the yarn prefix.
Getting an EACCES error when installing?
See NPM Resolving EACCESS permissions errors when installing packages globally.
Create a folder for your local project. For example, run mkdir local-cms-dev in the command line, which will create a directory. Then, run cd local-cms-dev to navigate to that directory.
hs init to connect the tools to your HubSpot account. This command will walk you through the steps below.
- To connect the CLI to a HubSpot account, you'll need to copy the account's personal access key. When prompted, press Enter to open hubspot.com to the personal access key page of the account. If you have multiple accounts, you'll be prompted in the browser to select an account first.
- On the personal access key page, you can generate a new personal access key or copy the existing key value if one already exists.
- If you're creating a key for the first time, select which scopes the key has access to. You'll need to select at least the Design Manager permission to interact with the account's design tools.
- After selecting the key's permissions, click Generate personal access key.
- Once a key has been generated, copy its value by first clicking Show under the key, then clicking Copy.
- Paste the key into the command line, then press Enter.
- Next, enter a name for the account. This name is only seen and used by you when running commands. For example, you might use "sandbox" if you're using a developer sandbox or "company.com" if you’re using a standard account. This name can't contain spaces.
- Press Enter.
With the init flow complete, you'll see a success message confirming that a configuration file, hubspot.config.yml, has been created in your current directory.
Your hubspot.config.yml will look something like this:
hubspot.config.yml file supports multiple accounts. To authenticate more accounts, run
hs auth and follow the prompts.
By default, HubSpot will interact with the
defaultPortal when running commands. To interact with other connected portals, you can include a --account= flag and use either the name or portalId value. For example, --account=345 and --account=sandbox will both interact with account ID
345 based on the above code.
Using the fetch command, run hs fetch --account=<name> <src> <dest> to get an entire projects folder tree and files from your HubSpot account into your local environment. The src is the project path in your HubSpot Design Tools, and the dest is the path to the local directory you would like the files to be placed, relative to your current working directory. To fetch the project to your current working directory, you can leave out the <dest> argument.
Here is an example of how you would fetch a project from your HubSpot account:
This is the Design Tools project we fetched to our local environment:
Using the upload command, run hs upload --account=<name> <src> <dest> to upload the project in your local environment to your HubSpot account. This will copy the contents of the <src> and upload them to your HubSpot account in the <dest>. If you're creating a new project in your Design Tools, the <dest> can be a net new folder in HubSpot.
Here is an example of how you would upload the example project into your HubSpot account:
Run hs watch --account=<name> <src> <dest> to watch your local directory and automatically upload changes to your HubSpot account on file saves.
Here is an example of how you would run that command with the watch command:
Thank you for your feedback, it means a lot to us.