contentful cli

Содержательный интерфейс командной строки

Инструмент интерфейса командной строки Contentful. Используйте функции Contentful прямо из интерфейса командной строки.

Contentful предоставляет инфраструктуру контента для цифровых команд, позволяющую размещать контент на веб-сайтах, в приложениях и устройствах. В отличие от CMS, Contentful был создан для интеграции с современным стеком программного обеспечения. Он предлагает центральный центр для структурированного контента, мощные API-интерфейсы управления и доставки, а также настраиваемое веб-приложение, которое позволяет разработчикам и создателям контента быстрее поставлять цифровые продукты.

Функции

• Начните работу с Contentful с помощью команды init .
• Управление пространствами: список, создание, удаление...
• Экспортируйте свое пространство в файл JSON.
• Импортируйте свое пространство из файла JSON.
• Выполнение сценариев миграции, написанных на Contentful Migration DSL.
• Создайте сценарии миграции для Contentful Migration DSL из существующих пространств.
• Заполните свое пространство примерами данных.
• Управляйте установкой расширений в помещении.
• Безопасный вход и выход из системы с помощью нашей службы OAuth.
• Найдите все доступные команды в разделе документации.

☁️ Установка

Убедитесь, что у вас установлен Node LTS.

Затем используя npm или пряжу:

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

Обратите внимание, что для неавтономных версий вам необходим Node LTS для использования CLI.

Использование

Используйте параметр --help для отображения раздела справки для инструмента CLI или в сочетании с определенной командой, чтобы получить раздел справки для этой команды.

contentful --help
# Or
contentful space --help

Документация

Более подробную документацию по каждой команде можно найти в разделе документации.

Использование инструмента CLI с прокси

Вы можете сохранить конфигурацию прокси-сервера в своем .contentfulrc.json с помощью:

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

Мы также уважаем переменные среды http(s)_proxy :

https_proxy=user:auth@host:port contentful

При наличии нескольких конфигураций прокси-сервера приоритет принимается в следующей форме:

1. http_proxy имеет приоритет над .contentfulrc.json
2. https_proxy имеет приоритет над .contentfulrc.json
3. https_proxy имеет приоритет над http_proxy

Настройка CLI для использования в ЕС

Вы можете переопределить конфигурацию хоста в вашем .contentfulrc.json с помощью:

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

Тогда любая последующая команда будет использовать хост EU. Например, contentful login позволит вам войти в свой экземпляр EU Contentful.

⛑️ Устранение неполадок

• Не можете подключиться к Contentful через прокси? Попробуйте настройки rawProxy: true в вашем .contentfulrc.json через:

contentful config add --raw-proxy

Разработка

1. Установить зависимости

   npm i

2. Чтобы избежать конфликта разрабатываемой версии с уже установленным Contentful CLI, измените имя команды в package.json

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

3. Свяжите свою локальную версию и удачного взлома?

   npm link

? Тестирование

Интеграционные тесты

Для локального запуска интеграционных тестов вам потребуется следующее:

1. Установите переменные среды в .jest/env.js (их можно найти в 1Password)

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

2. Запустите прокси-сервер Talkback для записи и воспроизведения http-запросов.

   npm run talkback-proxy

3. В другой терминальной оболочке запустите предпочитаемые вами тесты.

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

Модульные тесты

Просто запустите:

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

Дополнительную информацию о запуске тестов и дополнительных флагах см. в документации jest.

Обновление снимков

Возможно, вам придется обновить снимки, а с записями это сложно.

Совет: запускайте тесты без записей, чтобы обновить снимки.

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

❓ Поддержка

Если у вас возникли проблемы с этим инструментом, сообщите о проблеме здесь, на Github.

Если у вас есть другие проблемы с Contentful, не связанные с этой библиотекой, вы можете обратиться в службу поддержки.

✍️ Участие

См. CONTRIBUTING.md

Лицензия

Массачусетский технологический институт