contentful cli

CLI de contenu

L'outil d'interface de ligne de commande de Contentful. Utilisez les fonctionnalités Contentful directement depuis votre CLI.

Contentful fournit une infrastructure de contenu permettant aux équipes numériques d'alimenter le contenu des sites Web, des applications et des appareils. Contrairement à un CMS, Contentful a été conçu pour s'intégrer à la pile logicielle moderne. Il offre une plateforme centrale pour le contenu structuré, de puissantes API de gestion et de livraison, ainsi qu'une application Web personnalisable qui permet aux développeurs et aux créateurs de contenu de livrer plus rapidement des produits numériques.

Caractéristiques

• Démarrez avec Contentful avec la commande init .
• Gérer les espaces - lister, créer, supprimer,...
• Exportez votre espace vers un fichier JSON.
• Importez votre espace depuis un fichier JSON.
• Exécuter des scripts de migration écrits dans Contentful Migration DSL
• Générez des scripts de migration pour le DSL Contentful Migration à partir des espaces existants.
• Amorcez votre espace avec des exemples de données.
• Gérer l'installation des extensions dans un espace.
• Connectez-vous et déconnectez-vous en toute sécurité avec notre service OAuth.
• Recherchez toutes les commandes disponibles dans la section Documents.

☁️Installation

Assurez-vous que Node LTS est installé

Puis en utilisant npm ou fil :

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

Veuillez noter que pour les versions non autonomes, vous avez besoin de Node LTS pour utiliser la CLI.

Usage

Utilisez le paramètre --help pour afficher la section d'aide de l'outil CLI ou combiné avec une commande spécifique pour obtenir la section d'aide de cette commande.

contentful --help
# Or
contentful space --help

Documentation

Une documentation plus détaillée pour chaque commande peut être trouvée dans la section documentation.

Utilisation de l'outil CLI avec un proxy

Vous pouvez enregistrer la configuration du proxy dans votre .contentfulrc.json via :

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

Nous respectons également les variables d'environnement http(s)_proxy :

https_proxy=user:auth@host:port contentful

Lorsqu'il existe plusieurs configurations de proxy, la priorité est prise sous cette forme :

1. http_proxy a priorité sur .contentfulrc.json
2. https_proxy a priorité sur .contentfulrc.json
3. https_proxy est prioritaire sur http_proxy

Configuration de la CLI pour une utilisation dans l'UE

Vous pouvez remplacer la configuration de l'hôte dans votre .contentfulrc.json via :

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

Ensuite, toute commande ultérieure utilisera l’hôte EU. Par exemple, contentful login vous connectera à votre instance EU Contentful.

⛑️ Dépannage

• Impossible de vous connecter à Contentful via votre proxy ? Essayez les paramètres rawProxy: true dans votre .contentfulrc.json via :

contentful config add --raw-proxy

Développement

1. Installer les dépendances

   npm i

2. Pour éviter que la version de développement n'entre en collision avec votre CLI Contentful déjà installée, modifiez le nom de la commande dans package.json

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

3. Liez votre version locale, et bon hacking ?

   npm link

? Essai

Tests d'intégration

Pour exécuter des tests d'intégration localement, vous aurez besoin des éléments suivants :

1. Définir les variables d'environnement dans .jest/env.js (peut être trouvé dans 1Password)

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

2. Exécutez le proxy de talkback pour enregistrer et lire les requêtes http

   npm run talkback-proxy

3. Dans un autre shell de terminal, exécutez vos tests préférés

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

Tests unitaires

Exécutez simplement :

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

Voir la documentation de Jest pour plus de détails sur l'exécution des tests et les indicateurs facultatifs.

Mise à jour des instantanés

Vous devrez peut-être mettre à jour les instantanés et cela représente un défi avec les enregistrements.

Astuce : effectuez des tests sans enregistrements pour mettre à jour les instantanés.

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

❓ Prise en charge

Si vous rencontrez un problème avec cet outil, veuillez signaler un problème ici sur Github.

Si vous rencontrez d'autres problèmes avec Contentful non liés à cette bibliothèque, vous pouvez contacter le support client.

✍️ Contribuer

Voir CONTRIBUTION.md

Licence

MIT