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

执照

麻省理工学院