内容 CLI
内容CLI是帮助Celonis平台管理内容的工具. 它提供各种命令来帮助提取 内容如分析,软件包,资产和其他 从您的 Celonis 平台团队到您的本地机器 然后可以推到其他队伍。 通过为您创建不同的配置文件,可以轻松地实现此进程 在配置文件的上下文中组和执行命令.
目录
开始
要开始使用内容 CLI, 您需要 node 安装在您的本地机器中。 请下载
推荐给大多数用户的 LTS 版本 node 网页 这里之后
安装 node 您可以在终端中运行以下命令(cmd for Windows用户)来安装内容 CLI.
注意同一命令也用于更新内容 CLI .
npm install -g @celonis/content-cli
您可以通过在终端中运行以下命令来验证安装是否成功, 该命令会打印 已安装的 CLI 内容版本 :
content-cli -V
要开始使用内容 CLI, 您可以遵循一些实例来管理已有的内容 作为我们pycelonis实例库的一部分 这里。 。 。 .
关于项目
内容CLI有三个核心功能:
简介 : CLI通过剖析连接到Celonis平台环境. 对于您可以指定的每个命令 您想要使用的配置文件 。 这使得它的力量,从意义上说,你可以拉 一些东西,让我们说 将它直接推到第2组 很容易 您可以使用以下命令创建配置文件:
content-cli profile create
调: 此功能允许您从 Celonis 平台下载内容到您的本地机器 。 让我们拿工作室包 作为例子。 这些可以在 Celonis 平台中导出为包含所有软件包资产的ZIP文件. 使用下列方法 命令使用您创建的软件包密钥和配置文件,您将拉出 ZIP 文件.
content-cli pull package -p <profile-name> --key <package-key>
举例来说,如果想要从您的配置文件"My-dev-profile"中取出一个带有"兴趣-procage"密钥的包,命令会像这样:
content-cli pull package -p my-dev-profile --key interesting-package
推动 : 此功能允许您将内容文件推向 Celonis 平台中的团队. 为了继续最后的例子, 您可以使用以下命令来推动他先前在另一组中提取的软件包.
content-cli push package -p <profile-name> --spaceKey <space-key> -f <file-to-push.zip>
举例来说,如果想要将一个包从ziped文件"interesting-package.zip"推到带有空间"my-dev-profile"的配置组,命令会像这样:
content-cli push package -p my-dev-profile --spaceKey my-cool-space -f interesting-package.zip
内容CLI能力综合清单载于 文档。 。 。 .
您仍然可以探索内容 CLI 的全部能力和不同命令的选项列表
使用 -h 选项.
content-cli -h
content-cli pull package -h
命令图
打开交互式命令图 a 包括:
按命令区域分组的每个内容 CLI 命令的可搜索可视化,并显示描述和选项
。 现场直播从 docs/command-graph.html 源文件通过
(原始内容存档于2013-10-10). raw.githack.com,所以它可以在浏览器中直接制作而无需下载.
捐助者说明: 此图表必须手动同步 。 见 如何添加命令 说明 在添加或更改命令时更新它.
在当地建设和使用该项目
这个工具与Celonis平台紧密相联,所有能力都需要进入Celonis平台团队.
先决条件
- 节点.js
>=18.20.5(LTS建议)。 检查node -v。 。 。 . - 线条 软件包管理器。 安装方式
npm install -g yarn如果已经可用.
构建步骤
git clone https://github.com/celonis/content-cli.git
cd content-cli
yarn install
yarn build
构建将 TypeScript 编译为 dist/ 文件夹和副本 package.json 在这里.
运行已建 CLI
你可以直接从 dist 文件夹 :
node dist/content-cli.js -h
在全球安装当地建筑
用您的本地建筑作为全球 content-cli 命令 :
cd dist
npm link
这在全球范围内形成了象征性的联系 node_modules 目录,允许您运行 content-cli 从机器上的任何地方。 稍后要解开链接, 运行 npm unlink -g @celonis/content-cli。 。 。 .
解决问题
Error: Cannot find module '...'
如果你看到一个 Cannot find module 运行时出错 content-cli,依赖性可能无法正确安装:
- 全局安装 : 尝试更新到最新版本 :
npm install -g @celonis/content-cli@latest。 。 。 . - 地方发展: 运行
yarn install从工程根起,然后建起.
content-cli: command not found
- 确保节点.js安装并安装在您的
PATH(单位:千美元)node -v) (中文(简体) ). - 如果通过
npm install -g,检查 npm 全球bin目录在您的PATH您可以找到它与npm bin -g。 。 。 . - 如果使用
npm link确保你运行它从dist/目录( 不是工程根) .
节点.js 版本错误
内容 CLI 需要节点.js >=18.20.5。如果看到相容性错误,请升级您的节点.js安装。 我们建议使用 数字 来管理节点.js版本 :
nvm install --lts
nvm use --lts
释放进程
我们使用 Github 操作管理释放 Build and Publish Workflow。当需要发布更改时,此动作由代码所有人手动执行.
此举构建了项目,并向Github注册局公布了该软件包. 您可以安装
使用以下命令发布的内容 CLI 最新版本 :
npm i -g @celonis/content-cli
捐款
我们鼓励公众捐款! 请检查 捐款额 详细介绍我们 行为守则.
有关命令开发的详细情况,请参见: 如何添加命令 向导.
许可证
版权 (c) 2021 Celonis SE
这个项目根据麻省理工学院的许可证获得许可 见 自由主义 详细文件.