contentful cli

コンテンツフルな CLI

Contentful のコマンド ライン インターフェイス ツール。 Contentful 機能を CLI から直接使用します。

Contentful は、デジタル チームが Web サイト、アプリ、デバイスのコンテンツを強化するためのコンテンツ インフラストラクチャを提供します。 CMS とは異なり、Contentful は最新のソフトウェア スタックと統合するように構築されています。構造化コンテンツの中央ハブ、強力な管理および配信 API、および開発者やコンテンツ作成者がデジタル製品をより迅速に出荷できるようにするカスタマイズ可能な Web アプリを提供します。

特徴

• initコマンドを使用して Contentful を開始します。
• スペースの管理 - リスト、作成、削除など
• スペースを JSON ファイルにエクスポートします。
• JSON ファイルからスペースをインポートします。
• Contentful Migration DSL で記述された移行スクリプトを実行する
• 既存のスペースから Contentful Migration DSL の移行スクリプトを生成します。
• サンプル データをスペースにシードします。
• スペース内の拡張機能のインストールを管理します。
• OAuth サービスを使用して安全にログインおよびログアウトします。
• docs セクションで使用可能なすべてのコマンドを見つけてください。

☁️ インストール

Node LTS がインストールされていることを確認してください

次に、npm または Yarn を使用します。

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

非スタンドアロン バージョンの場合、CLI を使用するには Node LTS が必要であることに注意してください。

使用法

--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より優先されます

EU で使用するための CLI の設定

次の方法で.contentfulrc.jsonのホスト構成をオーバーライドできます。

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

その後、後続のコマンドはすべて EU ホストを使用します。たとえば、 contentful loginでは、EU Contentful インスタンスにログインします。

⛑️ トラブルシューティング

• プロキシ経由で Contentful に接続できませんか?次のようにして、 .contentfulrc.jsonでrawProxy: trueを設定してみてください。

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. トークバック プロキシを実行して 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 を参照してください。

ライセンス

マサチューセッツ工科大学