Content CLI
Content CLI is a tool to help manage content in Celonis Platform. It provides various commands to help extract content like analyses, packages, assets and others from your Celonis Platform team to your local machine, which you can then push to other teams. This process can be easily achieved by creating profiles for your different teams and execute commands in a profile's context.
Table of Contents
- Getting Started
- About the Project
- Command Graph
- Building the Project
- Troubleshooting
- Release Process
- Contributing
- License
Getting Started
To get started with using Content CLI, you will need to have node installed in your local machine. Please download the LTS version that is recommended for most users from the node web page here. After installing node you can run the following command in the terminal (cmd for Windows users) to install Content CLI. Note that the same command is used for updating Content CLI too.
npm install -g @celonis/content-cliYou can verify that the installation was successful by running the following command in the terminal, which prints the installed version of Content CLI:
content-cli -VTo get started with using Content CLI, you can follow some examples to manage content that are available as part of our pycelonis examples library here.
About the Project
Content CLI has three core functionalities:
Profile: The CLI connects to the Celonis Platform environments through profiles. For each of the commands you can specify which profile you want to use. This makes it powerful in the sense that you can pull something from let's say team1.cluser1 and push it directly to team2.cluster2 easily. You can create a profile using the following command:
content-cli profile createPull: This feature allows you to download content from the Celonis Platform to your local machine. Let's take Studio package as an example. These can be exported in the Celonis Platform as ZIP files that contain all package assets. By using the following command using the package key and profile you have created, you will pull the ZIP file.
content-cli pull package -p <profile-name> --key <package-key>Example, if you want to pull a package with key "interesting-package" from your profile "my-dev-profile", the command will look like this: