Local Development Tooling: CMS CLI Reference

Last updated: December 29, 2020


Argument	Description
`dest` Optional	Path to the remote developer file system directory you would like to list files for. If omitted, defaults to the account root.


Argument	Description
`src` Required	Path in HubSpot Design Tools
`dest` Optional	Path to the local directory you would like the files to be placed, relative to your current working directory. If omitted, this argument will default to your current working directory.


Options	Description
`--account`	Specify an `accountId` or name to fetch from Supports an alias of `--portal` for backward compatibility with older versions of the CLI.
`--overwrite`	Overwrite existing files with fetched files.
`--mode`	Specify if fetching a draft or published version of a file from HubSpot. Click here for more info


Argument	Description
`src` Required	Path to the local file, relative to your current working directory.
`dest` Required	Path in HubSpot Design Tools, can be a net new path.


Options	Description
`--account`	Specify a `accountId` or name to fetch from. Supports an alias of `--portal` for backward compatibility with older versions of the CLI.
`--mode`	Specify if uploaded files are published in HubSpot. See "modes" for more info.


Subcommands	Description
`filemanager`	Uploads the specified src directory to the File Manager, rather than to the developer file system in the Design Manager. Note: Uploaded files will be set to public, making them viewable by anyone with the URL. See our help documentation for more details on file visibility settings.


Argument	Description
`src` Required	Path to the local directory your files are in, relative to your current working directory
`dest` Required	Path in HubSpot Design Tools, can be a net new path.


Options	Description
`--account`	Specify a `accountId` or name to fetch from Supports an alias of `--portal` for backward compatibility with older versions of the CLI.
`--mode`	Specify if uploaded files are published or saved as drafts in HubSpot. Learn more about using modes.
`--initial-upload`	Causes an initial upload to occur before file saves have occured.
`--remove`	Will cause watch to delete files in your HubSpot account that are not found locally.
`--notify=<path/to/file>`	log to specified file when a watch task is triggered and after workers have gone idle.


Argument	Description
`src` Required	Path to the remote developer file system directory your files are in.
`dest` Required	Path to move assets to within the developer file system.


Options	Description
`--account`	Specify a `accountId` or name to move files within. Supports an alias of `--portal` for backward compatibility with older versions of the CLI.


Argument	Description
`type` Required	Type of asset. Supported types: `module` `template` `global-partial` `website-theme` `function` `webpack-serverless` `react-app` `vue-app`
`name` Required	Name of new asset
`dest` Optional	Destination folder for the new asset, relative to your current working directory. If omitted, this argument will default to your current working directory.


Argument	Description
`path` Required	Path in HubSpot Design Tools


Options	Description
`--account`	Specify a `accountId` or name to remove a file from. Supports an alias of `--portal` for backward compatibility with older versions of the CLI.


Argument	Description
`src` Required	The local JSON file to use to generate the HubDB table.


Options	Description
`--account`	Specify a `accountId` or name to create HubDB in. Supports an alias of `--portal` for backward compatibility with older versions of the CLI.


Argument	Description
`tableId` Required	HubDB table id found in the HubDB dashboard.
`dest`	The local path destination to store the `hubdb.json` file.


Options	Description
`--account`	Specify a `accountId` or name to fetch HubDB from. Supports an alias of `--portal` for backward compatibility with older versions of the CLI.


Argument	Description
`tableId` Required	HubDB table id found in the HubDB dashboard.


Options	Description
`--account`	Specify a `accountId` or name to clear HubDB rows from. Supports an alias of `--portal` for backward compatibility with older versions of the CLI.


Argument	Description
`tableId` Required	HubDB table id found in the HubDB dashboard.


Options	Description
`--account`	Specify a `accountId` or name to delete HubDB from. Supports an alias of `--portal` for backward compatibility with older versions of the CLI.

JSON

// store_locations.hubdb.json
{
 "name": "store_locations",
 "useForPages": true,
 "label": "Store locations",
 "allowChildTables": false,
 "allowPublicApiAccess": true,
"dynamicMetaTags": { "DESCRIPTION": 3, "FEATURED_IMAGE_URL": 7 },
 "enableChildTablePages": false,
 "columns": [
   { "name": "name", "label": "Name", "type": "TEXT" },
   {
     "name": "physical_location",
     "label": "Physical Location",
     "type": "LOCATION"
   },
   { "name": "street_address", "label": "Street address", "type": "TEXT" },
   { "name": "city", "label": "City", "type": "TEXT" },
   {
     "name": "state",
     "label": "State",
     "options": [
       { "id": 1, "name": "Wisconsin", "type": "option", "order": null },
       { "id": 2, "name": "Minnesota", "type": "option", "order": null },
       { "id": 3, "name": "Maine", "type": "option", "order": null },
       { "id": 4, "name": "New York", "type": "option", "order": null },
       { "id": 5, "name": "Massachusetts ", "type": "option", "order": null },
       { "id": 6, "name": "Mississippi", "type": "option", "order": null },
       { "id": 7, "name": "Arkansas", "type": "option", "order": null },
       { "id": 8, "name": "Texas", "type": "option", "order": null },
       { "id": 9, "name": "Florida", "type": "option", "order": null },
       { "id": 10, "name": "South Dakota", "type": "option", "order": null },
       { "id": 11, "name": "North Dakota", "type": "option", "order": null },
       { "id": 12, "name": "n/a", "type": "option", "order": null }
     ],
     "type": "SELECT",
     "optionCount": 12
   },
   { "name": "phone_number", "label": "Phone Number", "type": "TEXT" },
   { "name": "photo", "label": "Store Photo", "type": "IMAGE" }
 
 ],
 "rows": [
   {
     "path": "super_store",
     "name": "Super Store",
     "isSoftEditable": false,
     "values": {
       "name": "Super Store",
       "physical_location": {
         "lat": 43.01667,
         "long": -88.00608,
         "type": "location"
       },
       "street_address": "1400 75th Greenfield Ave",
       "city": "West Allis",
       "state": { "id": 1, "name": "Wisconsin", "type": "option", "order": 0 },
       "phone_number": "(123) 456-7890"
     }
   },
   {
     "path": "store_123",
     "name": "Store #123",
     "isSoftEditable": false,
     "values": {
       "name": "Store #123",
       "physical_location": {
         "lat": 32.094803,
         "long": -166.85889,
         "type": "location"
       },
       "street_address": "Pacific Ocean",
       "city": "at sea",
       "state": { "id": 12, "name": "n/a", "type": "option", "order": 11 },
       "phone_number": "(123) 456-7891"
     }
   }
 ]
}


Argument	Description
`--account`	The HubSpot account nickname from your hubspot.config. This parameter is required if you do not have a defaultAccount in your `hubspot.config`. Supports an alias of `--portal` for backward compatibility with older versions of the CLI.
`--compact`	displays only endpoint names and methods.
`--json`	Output JSON into the command line with data on all of the functions. The JSON data includes, portal id, function id, route, raw asset path, method, secrets, created and last modified dates.


Argument	Description
`endpoint-name` Required	The endpoint name as defined in your serverless.json file. It is not the path to your function file.


Options	Description
`--file`	Output the logs to function.log
`--follow`	Tail the logs to get a live update as you are executing your serverless functions.
`--latest`	Output only the most recent log
`--account`	The HubSpot account nickname from your hubspot.config. This parameter is required if you do not have a defaultPortal in your hubspot.config. Supports an alias of `--portal` for backward compatibility with older versions of the CLI.
`--compact`	hides log output/info. Returns success/error and execution time.
`--limit=<number>`	limit the amount of logs displayed in output


Argument	Description
`secret-name` Required	Name of secret.
`secret-value` Required	API key or other Auth detail.


Argument	Description
`secret-name` Required	Name of secret.
`secret-value` Required	API key or other Auth detail.


Argument	Description
`secret-name` Required	Name of secret you want to remove.


Argument	Description
`shortcut` Required	Provide the full shortcut name or alias of the short cut you wish to open in your browser.


Argument	Description
`--list` Required	Lists all of the shortcuts, their aliases and destinations.

By default there are some rules HubSpot automatically enforces. There is no way to override these defaults.

The following are always ignored:

hubspot.config.yml/hubspot.config.yaml
node_modules - dependencies
.* - hidden files/folders
*.log - NPM error log
*.swp - Swap file for Vim state
Icon\\r - Mac OS custom Finder icon
__MACOSX - Mac resource fork
~ Linux Backup file
Thumbs.db - Windows image file cache
ehthumbs.db - Windows folder config file
Desktop.ini - Windows custom folder attribute information
@eaDir - Windows Synology diskstation "hidden" folder where the server stores thumbnails.

Shell script

# ignore all files within a specific directory
/ignore/ignored
# ignore a specific file
/ignore/ignore.md
# ignore all .txt files
*.txt
# ignore all log files - useful if you commonly output serverless function logs as files.
*.log

The --mode option allows you to determine if local changes are published when uploaded to HubSpot. This option can be used in each command or set as a default in your hubspot.config.yml file.

The two options for --mode are --mode=draft and --mode=publish.

The following is the order of precedence for setting --mode:

Using --mode in a command will override all other settings.
Setting a defaultMode for each account in your hubspot.config.yml file, removes the need to use --mode in each command. It will override the top-level setting.
Setting a defaultMode at the top-level in your hubspot.config.yml file, sets a default--mode for all accounts. It will override the default behavior.
The default behavior for --mode is publish

If you ran hs init while using version v1.0.10 (released March 10, 2020) through v1.0.11 of the CLI your config file is placed at /Users/<username>/hubspot.config.yml.

We have changed back to placing your config file in the folder you ran the command from, to make it obvious where the file is. You do not have to move your config file it will still work fine. If you prefer to keep your file with your project files, it is safe to move your file from this directory to your project folder. Do not commit this file into version control, it contains your auth credentials.

If you ran the command using any other version of the CMS-CLI your config file is placed in the folder you ran the command from.

YAML

defaultPortal: DEV
portals:
  # Sample apikey entry, manually entered
  - name: DEV
    portalId: 123
    defaultMode: 'publish'
    authType: apikey
    apiKey: xxxxxx-xxxxx-xxxxx-xxxxx-xxxxx

  # Sample personal access key entry, generated from running hs auth personalaccesskey or hs init
  - name: PROD
    portalId: 456
    authType: personalaccesskey
    personalAccessKey: >-
      xxxxx-xxxxxx-xxxxxxx-xxxxxx-xxxxx-xxxxxxx-xxxxxxxx
    auth:
      tokenInfo:
        accessToken: >-
          xxxxx-xxxxxx-xxxxxxx-xxxxxx-xxxxx-xxxxxxx-xxxxxxxx
        expiresAt: '2020-01-01T00:00:00.000Z'


Name	Description
`defaultPortal` optional	Replaces the need to run commands using `--account=` to specify which account you are interacting with. If `--account=` is not specified when running a command, the `defaultPortal` will be used.
`defaultMode` optional	Which mode should be used for an account, draft or publish.
`allowUsageTracking` optional	Specifies if HubSpot has permission to track usage of the local development tools. Defaults to `true`. Set `false` to disable all tracking.


Name	Description
`portalId` required	The account ID of the account you are setting up authentication for.
`authType` required	Which form of authentication a given entry is using. `personalaccesskey` or `apikey`. NOTE: You must additionally set a config parameter for your authentication methods value. See the above example config file for how to set your `personalAccessKey` or `apiKey` in addition to specifying the `authType`.
`name` optional	A means to specify a name of an account, which can be used to denote which account a command should interact with. ex. `--account=123` and `--account=DEV` will both interact with account ID 123 based on the above example. This name can't contain spaces.
`defaultMode` optional	Which mode should be used for an account, draft or publish.

CMS Reference Docs

Local Development Tooling: CMS CLI Reference

Install

Upgrade

Commands

help

init

auth

Interacting with the developer file system

list

fetch

upload

watch

move

create

remove

HubDB Commands

Create HubDB table

Fetch HubDB Table

Clear rows in a HubDB table

Delete HubDB table

HubDB table JSON

Serverless Commands

list functions

logs

add secret

update secret

remove secret

list secrets

Open browser shortcuts

open

Command completion

Local Template Format

Local Module Format

.hsignore

Modes

Authentication

Top level config parameters

Account config parameters

Apps & Integrations

CMS

References

Community & Support

App Marketplace New

CMS Asset Marketplace

CMS Reference Docs

Local Development Tooling: CMS CLI Reference

Install

Upgrade

Commands

help

init

auth

Interacting with the developer file system

list

fetch

upload

watch

move

create

remove

HubDB Commands

Create HubDB table

Fetch HubDB Table

Clear rows in a HubDB table

Delete HubDB table

HubDB table JSON

Serverless Commands

list functions

logs

add secret

update secret

remove secret

list secrets

Open browser shortcuts

open

Command completion

Local Template Format

Local Module Format

.hsignore

Modes

Authentication

Top level config parameters

Account config parameters