contentful cli

內容豐富的 CLI

Contentful 的命令列介面工具。直接從 CLI 使用 Contentful 功能。

Contentful 為數位團隊提供內容基礎設施，以支援網站、應用程式和裝置中的內容。與 CMS 不同，Contentful 旨在與現代軟體堆疊整合。它提供了結構化內容的中心樞紐、強大的管理和交付 API 以及可自訂的 Web 應用程序，使開發人員和內容創建者能夠更快地交付數位產品。

特徵

• 使用init指令開始使用 Contentful。
• 管理空間 - 列出、建立、刪除...
• 將您的空間匯出到 JSON 檔案。
• 從 JSON 檔案匯入您的空間。
• 執行用 Contentful Migration DSL 編寫的遷移腳本
• 從現有空間產生內容遷移 DSL 的遷移腳本。
• 用範例資料為您的空間播種。
• 管理空間中擴充的安裝。
• 使用我們的 OAuth 服務安全登入和登出。
• 在文檔部分查找所有可用命令。

☁️安裝

確保您已安裝 Node LTS

然後使用npm或yarn：

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 以供 EU 使用

您可以透過以下方式覆蓋.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. 在另一個終端 shell 中執行您喜歡的測試

    # # 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

執照

麻省理工學院