contentful cli

CLI com conteúdo

Ferramenta de interface de linha de comando do Contentful. Use recursos de conteúdo diretamente de sua CLI.

Contentful fornece uma infraestrutura de conteúdo para equipes digitais potencializarem conteúdo em sites, aplicativos e dispositivos. Ao contrário de um CMS, o Contentful foi construído para se integrar à pilha de software moderna. Ele oferece um hub central para conteúdo estruturado, APIs poderosas de gerenciamento e entrega e um aplicativo da web personalizável que permite que desenvolvedores e criadores de conteúdo enviem produtos digitais com mais rapidez.

Características

• Comece com Contentful com o comando init .
• Gerencie espaços - liste, crie, exclua,...
• Exporte seu espaço para um arquivo JSON.
• Importe seu espaço de um arquivo JSON.
• Execute scripts de migração escritos na DSL Contentful Migration
• Gere scripts de migração para a DSL Contentful Migration a partir de espaços existentes.
• Promova seu espaço com dados de exemplo.
• Gerencie a instalação de extensões em um espaço.
• Faça login e logout com segurança com nosso serviço OAuth.
• Encontre todos os comandos disponíveis na seção de documentos.

☁️ Instalação

Certifique-se de ter o Node LTS instalado

Então usando npm ou fio:

npm install -g contentful-cli
# Or
yarn global add contentful-cli

Observe que para as versões não independentes você precisa do Node LTS para usar a CLI.

Uso

Use o parâmetro --help para exibir a seção de ajuda da ferramenta CLI ou combinado com um comando específico para obter a seção de ajuda desse comando.

contentful --help
# Or
contentful space --help

Documentação

Documentação mais detalhada para cada comando pode ser encontrada na seção de documentos.

Usando a ferramenta CLI com um proxy

Você pode salvar a configuração do proxy em seu .contentfulrc.json por meio de:

contentful config add --proxy user:auth@host:port

Também respeitamos as variáveis ​​de ambiente http(s)_proxy :

https_proxy=user:auth@host:port contentful

Quando existem múltiplas configurações de proxy, a precedência é tomada neste formato:

1. http_proxy tem precedência sobre .contentfulrc.json
2. https_proxy tem precedência sobre .contentfulrc.json
3. https_proxy tem precedência sobre http_proxy

Configurando a CLI para uso na UE

Você pode substituir a configuração do host em seu .contentfulrc.json por meio de:

contentful config add --host api.eu.contentful.com

Então, qualquer comando subsequente usará o host EU. Por exemplo, contentful login fará login na sua instância do EU Contentful.

⛑️ Solução de problemas

• Não é possível conectar-se ao Contentful por meio do seu proxy? Experimente as configurações rawProxy: true em seu .contentfulrc.json via:

contentful config add --raw-proxy

Desenvolvimento

1. Instalar dependências

   npm i

2. Para evitar que a versão de desenvolvimento colida com seu Contentful CLI já instalado, altere o nome do comando em package.json

     "bin": {
   -     "contentful": "bin/contentful.js"
   +     "ctfl": "bin/contentful.js"
     }

3. Vincule sua versão local e feliz hacking?

   npm link

? Teste

Testes de integração

Para executar testes de integração localmente, você precisará do seguinte:

1. Defina variáveis ​​de ambiente em .jest/env.js (pode ser encontrado em 1Password)

    process . env . CONTENTFUL_INTEGRATION_TEST_CMA_TOKEN = '<cma_auth_token>'
   process . env . CLI_E2E_ORG_ID = '<organization_id>'

2. Execute o proxy talkback para gravar e reproduzir solicitações http

   npm run talkback-proxy

3. Em outro terminal, execute seus testes preferidos

    # # Run all integration tests
   npm run test:jest
   # # Or run specific tests
   npx jest test/integration/cmds/space/ * --watch

Testes unitários

Basta executar:

 # Run all unit tests
npm run test:unit:watch
# Or run specific tests
npx jest test/unit/cmds/ * --watch

Consulte a documentação do jest para obter mais detalhes sobre a execução de testes e sinalizadores opcionais.

Atualizando instantâneos

Pode ser necessário atualizar os instantâneos e isso é um desafio com as gravações.

Dica: execute testes sem gravações para atualizar os snapshots.

 npx jest test/integration/cmds/<path to the affected test file> --updateSnapshot

❓ Suporte

Se você tiver algum problema com esta ferramenta, registre um problema aqui no Github.

Se você tiver outros problemas com o Contentful não relacionados a esta biblioteca, entre em contato com o Suporte ao Cliente.

✍️ Contribuindo

Veja CONTRIBUTING.md

Licença

MIT