Create a project (BETA)
Using projects, you can package, build, and deploy to HubSpot locally using the CLI. Depending on your HubSpot subscription, you can use projects to build the following:
- CRM UI extensions: if you have a Sales Hub or Service Hub Enterprise subscription, you can build UI extensions to customize CRM records.
Once deployed to HubSpot, you can view a project within your HubSpot account to see its build and deploy history, manage its settings, and monitor the private app’s usage.
To create a project from scratch:
- In the terminal, navigate to the folder where you'll be storing the project locally. A project can live anywhere locally, but will be stored in HubSpot as a root-level directory in the developer file system.
hs project create.
- Enter a name for your project, then hit Enter.
- Hit Enter to create the project with the suggested directory. Or enter a new directory path, then hit Enter.
- Select No template to create a project with no template. You can learn more about getting started with sample projects in the quickstart guide.
A project directory will then be created with the following assets:
hsproject.jsonfile in the root directory to configure the project.
The project's description.
The name of the directory that contains the rest of your project files.
The version of the developer project platform you're developing on. As improvements are made and features are added to the projects platform, some might include breaking changes. By specifying a version, you can control which features are accessible in your project. If not specified, the project will fall back to the current version.
srcfolder where you'll build your private app. This folder can have any name as long as it matches the
srcDirvalue in the
Next, upload the project to HubSpot by running
hs project upload. This will upload the empty project to your account where you can then view it.
To view your deployed project in HubSpot:
- In your HubSpot account, navigate to CRM Development.
- In the left sidebar menu, navigate to Projects. The project card will display a This project is empty message, which is expected because you've uploaded a project without a private app.
- Click the name of the project. The project details page will display information about build history once a private app is added to the project.
From the project details page, you can also manage auto-deploy settings:
- On the project page, click the Settings tab.
- Click to toggle the Auto-deploy successful builds switch off.
Next, create a private app in the project to start building out the project's functionality.
Thank you for your feedback, it means a lot to us.