Projects CLI commands (BETA)

The HubSpot CLI connects your local development tools to HubSpot, allowing you to develop on HubSpot with version control, your favorite text editor, and various web development technologies. 

Below, learn about the CLI commands available while you're developing with HubSpot projects.

Update the CLI

Update your CLI to the latest version.

npm i -g @hubspot/cli@latest

View all commands

List all project-specific CLI commands.

hs project help

To learn more about a specific command, enter the command followed by --help.

Create a new project

Create a project in a specified directory. You'll be prompted to give the project a name, as well as confirm the local location. You'll then select whether to start the project from scratch or from a sample template.

A new folder will be created in the specified directory containing an hsproject.json file and an src folder where you'll build out your project components

Once you've created a project, you can run other project commands inside your project directory and HubSpot will automatically recognize your project.

hs project create

Upload to HubSpot

Upload the project to your HubSpot account and create a build. If the project hasn't been created in the account yet, you'll be asked whether you want to create it.

If the project is configured to auto-deploy, this command will automatically deploy after the build is successful. By default, new projects are set to auto-deploy.

hs project upload

You can upload a project to a specific account in your hubspot.config.yml file by adding --account=accountName to the command. For example, hs project upload --account=main. This can be useful when switching between uploading to a sandbox account and then uploading to the main account. For example, your workflow might look like:

  • When developing your project in a sandbox, you upload changes with hs project upload--account=sandbox.
  • Then when uploading the project to a main account, you upload the project with hs project upload--account=main.

You can use the same configuration when using the watch command.

Deploy to HubSpot

Manually deploy the most recent build if the project is not set to auto-deploy. 

hs project deploy

You can deploy any build by adding --buildId=buildID. For example, hs project deploy --buildId=123.

Open project in HubSpot

Opens the project in HubSpot where you can view the project's settings, build history, and more. By default, will attempt to open the project in the default account set in hubspot.config.yml. Specify an account by adding the --account=accountName flag.

hs project open

Watch for changes

Watches the project directory and uploads to HubSpot upon saving, including deleting files. Each upload will result in a new build with a new build ID. A successful build will deploy automatically if the project’s auto-deploy setting is turned on.

hs project watch

You can further configure watch to send changes to a specific account with ---account=accountName. For example, hs project watch --account=main.

View logs

Get logs for a specific function within a project.

hs project logs

Running this command will guide you through selecting the project, app, and serverless function to get logs for. However, you can also manually specify this information by including the following flags in the command:

Use this table to describe parameters / fields
FlagDescription
--project=projectName

The name of the project as set in the hsproject.json file.

--app=appName

The name of the app as set in the app.json file.

--function=functionName

For app functions, the name of the serverless function as set in the serverless.json file.

--endpoint

For endpoint functions, the public endpoint path.

Use development sandboxes

Interact with development sandboxes using the commands below.

Create a sandbox

Creates a new development sandbox within a production account. A production account can only have one development sandbox active at a time. Learn more about development sandbox limits.

hs sandbox create

Delete a sandbox

Deletes a development sandbox. Follow the prompts to select the sandbox account to delete, then confirm the permanent deletion.

hs sandbox delete

Additional resources


Was this article helpful?
This form is used for documentation feedback only. Learn how to get help with HubSpot.