(简体中文)
Amplience动态内容服务的命令行界面.
说明
(简体中文) 是 Amplience 动态内容管理 APIs 的命令行界面应用程序.
运行 dc-cli --help 以获取可用的命令列表.
安装
从国家防范机制软件包管理器安装DC CLI可以使用以下命令:
npm install -g @amplience/dc-cli
或者你可以下载操作系统的可执行文件 页 次。 。 。 .
配置
(简体中文) 需要一套有效的Amplience客户证书和中枢ID(--hubId)进行手术。 您可以使用客户身份和秘密进行认证( Name--clientId 打开 --clientSecret)或个人访问标志(--patToken) (中文(简体) ).
这些参数必须在使用 CLI 之前使用下列命令之一设定 :
dc-cli configure --clientId <YOUR_CLIENT_ID> --clientSecret <YOUR_CLIENT_SECRET> --hubId <YOUR_HUB_ID>
dc-cli configure --patToken <YOUR_PERSONAL_ACCESS_TOKEN> --hubId <YOUR_HUB_ID>
一些命令( E)content-item copy, (中文(简体) ), content-item move,并 hub-clone)允许以单一命令输出和导入内容。 客户资格还有其他选择(--dstClientId 打开 --dstSecret)和中枢ID(--dstHubId)是一个独特的动态内容中心。 如果没有提供目的地选项,这些命令的目的地将与源相同.
工具配置完成后, 单个参数可以在运行任何命令时通过提供来覆盖, 例如 dc-cli <command> <action> --hubId <YOUR_HUB_ID>。 。 。 .
默认情况下, 配置会被保存到目录中的文件 <HOME_DIR>/.amplience/,使用 --config 选项.
选项
| 选项名称 | 类型 | 说明 |
|---|---|---|
| --版本 | [叫声] | 显示版本编号 |
| -- 客户身份 | [弦] [须 | 源中心客户端ID |
| --客户安全 | [弦] [须 | 源中心客户端秘密 |
| -- patToken 语句 | [弦] [须 | 源中心的个人访问令牌 |
| - 呼号 | [弦] [须 | 源代码中心 |
| --配置 | [弦] [默认:"~. amplience/dc-cli-config.json"] | JSON 配置文件的路径 |
| -- 帮助 | [叫声] | 显示帮助 |
| --日志 | [弦] [默认:(生成值)] | 要写入日志文件的路径 . |
| --dst HubId (英语) | [弦] | 目的地中心号 如未明确,则会同出处. |
| --dst 客户端 | [弦] | 目的地账户的客户身份 如未明确,则会同出处. |
| --dstSecret (英语) | [弦] | 目的地账户的秘密。 必须同时使用 dstClientId . |
实例
使用客户端ID和秘密创建/更新单个中枢配置文件
dc-cli configure --clientId foo --clientSecret bar --hubId baz
使用个人访问符创建/更新单个中枢的配置文件
dc-cli configure --patToken foo --hubId baz
创建/ 更新用于双色调的配置文件( 复制/ 移动/ clone)
dc-cli configure --clientId foo --clientSecret bar --hubId baz --dstClientId qux --dstSecret quux --dstHubId quuz
使用替代配置 hub 命令
使用 中枢 子命令,您可以保存枢纽配置供稍后检索.
此命令增加了一个中枢, 并提供了证书 :
dc-cli hub add --clientId <clientId> --clientSecret <clientSecret> --hubId <hubId>
然后,为了使用中枢,可以指代它的名称或中枢ID的一部分:
dc-cli hub use <hubIdOrName>
命令类别
内容类型图
这一类别包括与内容类型计划的互动.
这些命令可用于检索一个或多个计划的信息,创建新的计划,从单个中心站输出和导入计划,以及归档和无存档计划.
内容类型
该类包括了与内容类型的互动.
这些命令可用于检索一个或多个类型的信息,注册新类型或更新现有类型,从单个枢纽导出和导入类型,以及归档和无存档类型.
在导入内容类型之前, 您必须确保一个有效的 内容类型计划a 存在于每种类型的目的中心.
内容项目
这一类别包括与内容项目的互动.
这些命令可用于从单个中枢输出和导入内容,复制和移动中枢之间的项目,以及归档和无存档内容.
在导入、复制或移动内容之前,您必须确保有效 内容类型 存在于每个内容项目的目的地中心.
扩展
该类包括了与动态内容的UI扩展的交互,可用于从单个中枢导出,导入和删除扩展.
搜索索引
这一类别包括与Algolia搜索索引的动态内容互动,可用于从单个枢纽导出和导入索引.
内容存储器
这一类别包括与动态内容库的互动.
这些命令可用于获取特定寄存器的细节,列出多个寄存器,或者从寄存器中指定或取消指定内容类型.
事件
这一类包括与动态内容事件及其组成部分(Editions, Slots,和Snapshots)的互动. 这些命令可用于导出和导入事件,以及归档事件.
设置
这一类别包括与动态内容枢纽的支持属性的互动。 这些命令可用于导出和导入一个枢纽的断点设置,用于可视化,预览应用程序,工作流程状态,以及地产.
中枢
这一类别包括与动态内容中心的全部互动.
这些命令可用于将一个枢纽的设置和内容全部复制到另一个枢纽,或者将一个可以存档的枢纽的所有部分归档.
此外,这些命令还可用于存储和取回枢纽配置.
任务
这一类包括与动态内容工作的互动.
链接内容存储器
这一类别包括与动态内容链接的内容存储库的互动.
这些命令可用于列出多个链接的内容寄存器.
网点
该类包括了与动态内容的UI Webhooks的交互,可用于从单个中枢导出,导入和删除webhooks.
建设国家综合倡议
我们列入了一些国家预防机制的文字,以帮助创建国家行动倡议的各种设施.
所需权限
下面概述了运行CLI每个指令所需的详细权限. 要申请运行 CLI 的 API 密钥, 请联系 Amplience 支持 .
| 命令 | 所需空调 | 所需的功能权限 |
|---|---|---|
configure | 枢纽 - 读取 | |
content-repositories get <id> | 枢纽 - 读取 | 内容:职能:替代:READ |
content-repositories list | 枢纽 - 读取 | 内容:职能:替代:READ |
content-repositories assign-content-type <id> | 内容存储器 - EDIT 枢纽 - 读取 | 内容:职能:替代: |
content-repositories unassign-content-type <id> | 内容存储器 - EDIT 枢纽 - 读取 | 内容:职能:替代: |
content-type get <id> | 枢纽 - 读取 | 内容:职能: 职能: |
content-type list | 枢纽 - 读取 | 内容:职能: 职能: |
content-type register | 枢纽 - 读取 | 内容:职能:职能:职能:职能:职能:职能 |
content-type sync [id] | 枢纽 - 读取 | 内容:职能: |
content-type update <id> | 枢纽 - 读取 | 内容:职能: |
content-type import <dir> | 内容存储器 - EDIT 枢纽 - 读取 | 内容:职能: 职能: 内容:职能:职能:职能:职能:职能:职能 内容:职能: |
content-type export <dir> | 枢纽 - 读取 | 内容:职能: 职能: |
content-type-schema create | 枢纽 - 读取 | 内容:职能:职能:职能:职能:职能:职能 |
content-type-schema get <id> | 枢纽 - 读取 | 内容:职能: 职能: |
content-type-schema list | 枢纽 - 读取 | 内容:职能: 职能: |
content-type-schema update <id> | 枢纽 - 读取 | 内容:职能: |
content-type-schema import <dir> | 枢纽 - 读取 | 内容:职能: 职能: 内容:职能:职能:职能:职能:职能:职能 内容:职能: |