Comandos CLI da HubSpot

Last updated: Novembro 15, 2023

Use this table to describe parameters / fields
Parameter	Description
`accountNameOrID`	Identifique a nova conta padrão pelo seu nome (conforme definido no arquivo de configuração) ou ID.

Use this table to describe parameters / fields
Parameter	Description
`accountNameOrID`	Identifique a conta para removê-la pelo seu nome (conforme definido no arquivo de configuração) ou ID.


Argumento	Description
`dest` Opcional	Caminho para o diretório remoto do sistema de arquivos do desenvolvedor do qual você gostaria de listar os arquivos. Se omitido, assume a raiz da conta.


Argumento	Description
`src` Obrigatório	Caminho nas Ferramentas de design do HubSpot
`dest` Opcional	Caminho do diretório local em que você gostaria que os arquivos fossem colocados, em relação ao diretório de trabalho atual. Se omitido, esse argumento assumirá o diretório de trabalho atual.


Opções	Description
`--account`	Especifique um `accountId` ou nome para buscar. Suporta o alias `--portal` para compatibilidade retroativa com versões anteriores da CLI.
`--overwrite`	Substitui os arquivos existentes pelos arquivos buscados.
`--mode`	Especifica se deve ser buscado um rascunho ou uma versão publicada de um arquivo no HubSpot. Clique aqui para obter mais informações


Argumento	Description
`src` Obrigatório	Caminho para o arquivo local; relativo ao seu diretório de trabalho atual.
`dest` Obrigatório	Caminho nas Ferramentas de design do HubSpot; pode ser um caminho novo.


Opções	Description
`--account`	Especifique um `accountId` ou nome para buscar. Suporta o alias `--portal` para compatibilidade retroativa com versões anteriores da CLI.
`--mode`	Especifique se os arquivos carregados estão publicados no HubSpot. Consulte "modos" para obter mais informações.
`--clean`	Um sinalizador opcional que excluirá o diretório de destino e seu conteúdo antes de fazer upload.


Subcomandos	Description
`filemanager`	Carrega o diretório src especificado no Gerenciador de arquivos, e não no sistema de arquivos do desenvolvedor no Gerenciador de design. Observação: os arquivos carregados serão definidos como public e ficarão visíveis por qualquer pessoa que tenha a URL. Consulte nossa documentação de ajuda para obter mais detalhes sobre as configurações de visibilidade de arquivos.

Monitore o diretório local e faça upload automaticamente das alterações nos arquivos salvos em sua conta da HubSpot. Todas as alterações feitas ao salvar serão aplicadas imediatamente.

Considere o seguinte ao usar watch:

A exclusão dos arquivos monitorados localmente não os excluirá automaticamente do HubSpot. Para excluir os arquivos, use --remove.
Renomear uma pasta localmente causará o upload de uma nova pasta com o novo nome no HubSpot. A pasta existente no HubSpot não será apagada automaticamente. Para apagar a pasta, use --remove.


Argumento	Description
`src` Obrigatório	Caminho para o diretório local em que seus arquivos residem, em relação ao diretório de trabalho atual
`dest` Obrigatório	Caminho nas Ferramentas de design do HubSpot; pode ser um caminho novo.


Opções	Description
`--account`	Especifique um `accountId` ou nome a ser buscado Suporta o alias `--portal` para compatibilidade retroativa com versões anteriores da CLI.
`--mode`	Especifique se os arquivos carregados devem ser publicados ou salvos como rascunhos no HubSpot. Saiba mais sobre como usar os modos.
`--initial-upload`	Faz com que um upload inicial ocorra antes que os arquivos salvos tenham ocorrido. Suporta o alias `-i`
`--remove`	Causará a exclusão de arquivos não encontrados localmente na sua conta da HubSpot.
`--notify=<path/to/file>`	Registra no arquivo especificado quando uma tarefa de monitoramento é acionada e após os trabalhadores terem ficado ociosos.


Argumento	Description
`src` Obrigatório	Caminho para o diretório remoto do sistema de arquivos do desenvolvedor em que seus arquivos estão.
`dest` Obrigatório	Caminho para mover ativos para o sistema de arquivos do desenvolvedor.


Opções	Description
`--account`	Especifique um `accountId` ou nome ao qual mover os arquivos. Suporta o alias `--portal` para compatibilidade retroativa com versões anteriores da CLI.


Argumento	Description
`type` Obrigatório	Tipo de ativo. Os tipos compatíveis incluem: `module` `template` `website-theme` `function` `webpack-serverless` `react-app` `vue-app`
`name` Obrigatório	O nome do novo ativo
`dest` Opcional	A pasta de destino do novo ativo, em relação ao seu diretório de trabalho atual. Se omitido, assumirá o diretório de trabalho atual.


Argumento	Description
`path` Obrigatório	Caminho nas Ferramentas de design do HubSpot


Opções	Description
`--account`	Especifique um `accountId` ou um nome para remover um arquivo. Suporta o alias `--portal` para compatibilidade retroativa com versões anteriores da CLI.

Por padrão, existem algumas regras que o HubSpot aplica automaticamente. Não é possível substituir estes padrões.

Os seguintes itens são sempre ignorados:

hubspot.config.yml/hubspot.config.yaml
node_modules - dependências
.* - arquivos/pastas ocultas
*.log - log de erros NPM
*.swp - arquivo de permuta para o estado Vim
Icon\\r - ícone padrão do Finder no Mac OS
__MACOSX - recurso do Mac
~ - arquivo de backup do Linux
Thumbs.db - cache de arquivo de imagem do Windows
ehthumbs.db - arquivo de configuração de pasta do Windows
Desktop.ini - informação dos atributos de pasta personalizada do Windows
@eaDir - pasta "oculta" do diskstation Synology para Windows onde o servidor armazena as miniaturas.

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


Argumento	Description
`src` Obrigatório	O arquivo JSON local a ser utilizado para gerar a tabela do HubDB.


Opções	Description
`--account`	Especifique um `accountId` ou um nome para criar o HubDB. Suporta o alias `--portal` para compatibilidade retroativa com versões anteriores da CLI.


Argumento	Description
`tableId` Obrigatório	Identificação da tabela HubDB encontrada no painel do HubDB.
`dest`	O caminho local de destino para armazenar o arquivo `hubdb.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" } } ] }


Argumento	Description
`tableId` Obrigatório	Identificação da tabela HubDB encontrada no painel do HubDB.


Opções	Description
`--account`	Especifique um `accountId` ou nome para apagar nas linhas do HubDB. Suporta o alias `--portal` para compatibilidade retroativa com versões anteriores da CLI.


Argumento	Description
`tableId` Obrigatório	Identificação da tabela HubDB encontrada no painel do HubDB.


Opções	Description
`--account`	Especifique um `accountId` ou um nome para excluir do HubDB. Suporta o alias `--portal` para compatibilidade retroativa com versões anteriores da CLI.


Argumento	Description
`--account`	O apelido da conta da HubSpot do seu hubspot.config. Este parâmetro é obrigatório se você não tiver um defaultAccount em seu `hubspot.config`. Suporta o alias `--portal` para compatibilidade retroativa com versões anteriores da CLI.
`--json`	Saída do JSON para a linha de comando com os dados de todas as funções. Os dados JSON incluem: ID do portal, ID da função, rota, caminho do ativo bruto, método, segredos, datas de criação e última modificação.


Argumento	Description
`endpoint-name` Obrigatório	O nome do endpoint conforme definido no arquivo serverless.json (não o caminho para o arquivo de função).
`--file`	Saída de logs para function.log
`--follow`	Ajuste os logs para obter uma atualização dinâmica enquanto você executa suas funções sem servidor.
`--latest`	Apresenta apenas do log mais recente
`--account`	O apelido da conta da HubSpot do seu hubspot.config. Este parâmetro é obrigatório se você não tiver um defaultPortal em seu hubspot.config. Suporta o alias `--portal` para compatibilidade retroativa com versões anteriores da CLI.
`--compact`	oculta a saída/informações do log. Retorna sucesso/erro e o tempo de execução.
`--limit=<number>`	limitar a quantidade de logs exibidos na saída


Argumento	Description
`secret-name` Obrigatório	Nome do segredo.
`secret-value` Obrigatório	O valor do segredo (detalhes da autenticação ou não).


Argumento	Description
`secret-name` Obrigatório	O nome do segredo, que você usará mais tarde para fazer referência ao segredo. Pode ser qualquer valor exclusivo, embora seja recomendado mantê-lo simples para facilitar o uso.


Argumento	Description
`secret-name` Obrigatório	Nome do segredo que deseja remover.


Argumento	Description
`shortcut` Obrigatório	Forneça o nome completo do atalho ou o alias do atalho que você deseja abrir no navegador.


Argumento	Description
`--list` Obrigatório	Lista todos os atalhos, seus alias e destinos.

Use this table to describe parameters / fields
Parameter	Description
`--theme-path` Obrigatório	Caminho para um tema no Gerenciador de Design.
`--verbose`	Quando esse parâmetro é excluído, a pontuação retornada é uma média de todos os modelos do tema (padrão). Quando esse parâmetro é incluído, as pontuações de modelo individuais são mostradas. Você também receberá links de relatório do Lighthouse para cada modelo.
`--target`	Você pode ver a pontuação respectiva no computador ou no dispositivo móvel. Por padrão, o destino é o computador.

Ao criar um tema, use o seguinte comando para gerar um arquivo editor-preview.json, que mapeia os seletores CSS para os campos do tema. Isso permite que os criadores de conteúdo vejam quais elementos do tema serão afetados pelas atualizações nas opções de estilo de um campo.

Depois de executar o comando, você precisará revisar e refinar o arquivo editor-preview.json para garantir que os campos e os seletores sejam mapeados corretamente. Embora este comando faça uma suposição rudimentar sobre os campos que afetam os seletores, você precisará fazer correções com base em como seu tema é construído. Por exemplo, este comando não detecta quando os módulos substituem o estilo ou quando você usa macros. Saiba mais sobre destaque de campos no editor de temas.

A opção --mode permite determinar se as alterações locais são publicadas ao serem carregadas no HubSpot. Essa opção pode ser utilizada em cada comando ou definida como padrão no arquivo hubspot.config.yml.

As duas opções para --mode são --mode=draft e --mode=publish.

A ordem de precedência para definir --mode é a seguinte:

Usar --mode em um comando substituirá todas as outras configurações.
Definir um defaultMode para cada conta no arquivo hubspot.config.yml elimina a necessidade de usar --mode em cada comando. Isso substituirá a configuração de nível superior.
Definir um defaultMode de nível superior no arquivo hubspot.config.yml define um--mode para todas as contas. Isso substituirá o comportamento padrão.
O comportamento padrão para --mode é publish


Nome	Description
`HUBSPOT_PORTAL_ID` Obrigatório	O ID da conta da HubSpot.
`HUBSPOT_PERSONAL_ACCESS_KEY` Recomendado	A chave de acesso pessoal de um usuário na conta da HubSpot. Todas as atualizações feitas serão associadas a este usuário.
`HUBSPOT_CLIENT_ID`	O ID do cliente de OAuth.
`HUBSPOT_CLIENT_SECRET`	O segredo de OAuth.

Observação: a partir de 30 de novembro de 2022, as chaves de API da HubSpot serão desativadas e não terão mais suporte. Continuar usando as chaves de API da HubSpot representará um risco de segurança para sua conta e dados. Durante esta fase, a HubSpot poderá desativar sua chave a qualquer momento.

Você deve autenticar usando um token de acesso de aplicativo privado ou OAuth. Saiba mais sobre essa alteração e como migrar uma integração de chave de API para usar um aplicativo privado.

O comando de validação do tema permite executar rapidamente testes automatizados no seu tema para identificar problemas que precisam ser corrigidos antes do envio ao marketplace de ativos. Eles serão retornados na CLI como uma lista de mensagens [erro] e [sucesso] separadas em grupos que representam os tipos de ativos dentro de um tema.

Antes de validar um tema, você precisará primeiro enviá-lo para sua conta com hs upload. Em seguida, execute o seguinte comando para validar o tema carregado.


Argumento	Description
`src` Obrigatório	Caminho raiz relativo para a pasta do tema no gerenciador de design.


Argumento	Description
`src` Obrigatório	Caminho raiz relativo para a pasta do módulo no gerenciador de design.

Compartilhe seu feedback

Este artigo foi útil? Sim Não

Este formulário deve ser usado apenas para fazer comentários sobre esses artigos. Saiba como obter ajuda para usar a HubSpot..

Apps & Integrations

CMS

Developer References

Developer Community

App Ecosystem New

Template Marketplace

App Partner Program

CMS Reference Docs

Comandos CLI da HubSpot

Mostrar todos os comandos

Instalar a CLI

Instalar apenas no diretório atual

Atualizar a CLI

Autenticação

init

Autenticar uma conta

Listar contas autenticadas

Definir conta padrão

Remover uma conta

Remover contas inválidas

Interagir com o sistema de arquivos do desenvolvedor

Arquivos da lista

Buscar arquivos

Carregar arquivos

Definir um monitoramento para o carregamento automático

Mover arquivos

Criar novos arquivos

Remover arquivos

Ignorar arquivos

Comandos do HubDB

Criar tabela do HubDB

Buscar tabela do HubDB

Limpar linhas em uma tabela do HubDB

Excluir tabela do HubDB

Comandos de função sem servidor

Criar uma função

Funções de lista

Obter registros

Adicionar um segredo

Atualizar um segredo

Remover um segredo

Listar segredos

Abrir atalhos do navegador

open

Conclusão do comando

Avaliar temas e modelos para SEO e acessibilidade

Gerar seletores de campo de tema para destaques no aplicativo

Modos

Environment variables

Validação do ativo do marketplace

Validar o tema

Validar módulo

Compartilhe seu feedback