contentful cli

Inhaltliche CLI

Das Befehlszeilenschnittstellentool von Contentful. Nutzen Sie Contentful-Funktionen direkt von Ihrer CLI aus.

Contentful bietet eine Content-Infrastruktur für digitale Teams, um Inhalte auf Websites, Apps und Geräten bereitzustellen. Im Gegensatz zu einem CMS wurde Contentful für die Integration in den modernen Software-Stack entwickelt. Es bietet einen zentralen Hub für strukturierte Inhalte, leistungsstarke Verwaltungs- und Bereitstellungs-APIs und eine anpassbare Web-App, die es Entwicklern und Inhaltserstellern ermöglicht, digitale Produkte schneller zu liefern.

Merkmale

• Beginnen Sie mit Contentful mit dem Befehl init .
• Räume verwalten – auflisten, erstellen, löschen,...
• Exportieren Sie Ihren Space in eine JSON-Datei.
• Importieren Sie Ihren Space aus einer JSON-Datei.
• Führen Sie in der Contentful Migration DSL geschriebene Migrationsskripts aus
• Generieren Sie Migrationsskripte für die Contentful Migration DSL aus vorhandenen Bereichen.
• Füllen Sie Ihren Bereich mit Beispieldaten.
• Verwalten Sie die Installation von Erweiterungen in einem Bereich.
• Melden Sie sich sicher mit unserem OAuth-Dienst an und ab.
• Alle verfügbaren Befehle finden Sie im Abschnitt „Dokumente“.

☁️ Installation

Stellen Sie sicher, dass Node LTS installiert ist

Dann mit npm oder Garn:

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

Bitte beachten Sie, dass Sie für die nicht eigenständigen Versionen Node LTS benötigen, um die CLI verwenden zu können.

Verwendung

Verwenden Sie den Parameter --help , um den Hilfeabschnitt für das CLI-Tool anzuzeigen, oder kombinieren Sie ihn mit einem bestimmten Befehl, um den Hilfeabschnitt für diesen Befehl abzurufen.

contentful --help
# Or
contentful space --help

Dokumentation

Eine ausführlichere Dokumentation zu jedem Befehl finden Sie im Abschnitt „Dokumente“.

Verwendung des CLI-Tools mit einem Proxy

Sie können die Proxy-Konfiguration in Ihrer .contentfulrc.json speichern über:

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

Wir respektieren auch die Umgebungsvariablen http(s)_proxy :

https_proxy=user:auth@host:port contentful

Wenn mehrere Proxy-Konfigurationen vorhanden sind, wird der Vorrang in dieser Form eingenommen:

1. http_proxy hat Vorrang vor .contentfulrc.json
2. https_proxy hat Vorrang vor .contentfulrc.json
3. https_proxy hat Vorrang vor http_proxy

Konfigurieren der CLI für die EU-Nutzung

Sie können die Hostkonfiguration in Ihrer .contentfulrc.json überschreiben über:

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

Dann verwendet jeder nachfolgende Befehl den EU-Host. Mit contentful login werden Sie beispielsweise bei Ihrer EU-Contentful-Instanz angemeldet.

⛑️ Fehlerbehebung

• Sie können über Ihren Proxy keine Verbindung zu Contentful herstellen? Versuchen Sie die Einstellungen rawProxy: true in Ihrer .contentfulrc.json über:

contentful config add --raw-proxy

Entwicklung

1. Abhängigkeiten installieren

   npm i

2. Um zu vermeiden, dass die Entwicklungsversion mit Ihrer bereits installierten Contentful-CLI kollidiert, ändern Sie den Befehlsnamen in package.json

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

3. Verknüpfen Sie Ihre lokale Version und viel Spaß beim Hacken?

   npm link

? Testen

Integrationstests

Um Integrationstests lokal auszuführen, benötigen Sie Folgendes:

1. Umgebungsvariablen in .jest/env.js festlegen (zu finden in 1Password)

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

2. Führen Sie den Talkback-Proxy aus, um HTTP-Anfragen aufzuzeichnen und wiederzugeben

   npm run talkback-proxy

3. Führen Sie in einer anderen Terminal-Shell Ihre bevorzugten Tests aus

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

Unit-Tests

Führen Sie einfach Folgendes aus:

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

Weitere Informationen zum Ausführen von Tests und optionalen Flags finden Sie in der Jest-Dokumentation.

Snapshots aktualisieren

Möglicherweise müssen Sie Schnappschüsse aktualisieren, was bei den Aufnahmen eine Herausforderung darstellt.

Tipp: Führen Sie Tests ohne Aufzeichnungen durch, um die Snapshots zu aktualisieren.

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

❓ Unterstützung

Wenn Sie ein Problem mit diesem Tool haben, melden Sie es bitte hier auf Github.

Wenn Sie andere Probleme mit Contentful haben, die nichts mit dieser Bibliothek zu tun haben, können Sie sich an den Kundendienst wenden.

✍️Mitwirken

Siehe CONTRIBUTING.md

Lizenz

MIT