Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
dc61743
Bring code to blank state
ZgjimHaziri May 14, 2025
fd55a1e
TA-3749: Define Content CLI foundation (#198)
ZgjimHaziri May 16, 2025
ee6467e
TA-3750: Setup command modules (#199)
ZgjimHaziri May 19, 2025
276ea4f
TA-3771: Migrate Data Pipeline commands (#201)
ZgjimHaziri May 22, 2025
2c2e5d2
TA-3767: Migrate Studio commands (#202)
ZgjimHaziri May 22, 2025
46bc990
TA-3769: Migrate Analysis commands (#203)
ZgjimHaziri May 22, 2025
5cf37d1
TA-3770: Migrate CPM4 commands (#204)
ZgjimHaziri May 22, 2025
9ad11a3
TA-3768: Setup test config (#205)
ZgjimHaziri May 26, 2025
d7f107d
Upgrade axios to latest version (#208)
promeris May 26, 2025
b0bc472
TA-3794: Handle outstanding issues in refactor (#209)
promeris May 30, 2025
c714d8a
TA-3745: Provide default profile-setting option (#210)
ZgjimHaziri Jun 13, 2025
e15a5df
TA-3754: Refactor publishing (#213)
ZgjimHaziri Jun 13, 2025
cac2ee8
TA-3754: Minor refactoring (#211)
ZgjimHaziri Jun 16, 2025
8ea093c
TA-3754: Simplify ContentService (#212)
ZgjimHaziri Jun 16, 2025
a8fbe9d
TA-3752: Deprecate Studio export/import commands (#215)
ZgjimHaziri Jun 18, 2025
626dce8
TA-3753: Merge branch `master` into content-cli-v2-refactoring
ZgjimHaziri Jun 18, 2025
514cd23
TA-3753: Uncomment CODEOWNERS
ZgjimHaziri Jun 18, 2025
9f0f503
TA-3753: Remove custom branch from build workflow
ZgjimHaziri Jun 18, 2025
0258692
TA-3756: Update running local build section
ZgjimHaziri Jun 18, 2025
55232e0
TA-3756: Update release process doc
ZgjimHaziri Jun 18, 2025
493cde0
TA-3756: Update bin
ZgjimHaziri Jun 19, 2025
df46708
TA-3756: Update documentation to fit the bin change
ZgjimHaziri Jun 19, 2025
f6f3f84
Merge branch 'master' of github.com:celonis/content-cli into TA-3756-…
ZgjimHaziri Jun 19, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,29 +82,36 @@ content-cli -h
content-cli pull package -h
```

## Building the Project
## Building and Using the Project locally

This tool is tightly connected with the Celonis EMS and all capabilities require to have access to a Celonis EMS Team.
After cloning the project, the next step is to install the project dependencies. We use `yarn` as our package manager,
so running `yarn install` on the project root folder should install all the necessary dependencies. After installing
the project dependencies, you can run `yarn build` to build the project artifact. To use the built artifact, you can
run `node content-cli.js` in the generated `dist` folder.

If we want to use a specific local build of the tool globally, we can do this by:
- Move to the root directory of the project.
- Execute the `npm link` command.
This will create a symbolic link in the global `node_modules` directory, allowing you to run the CLI from anywhere on your machine.

## Release Process

We manage releases using Github Actions with the `Build and Publish Workflow`. This action runs after merging to
the master branch, which builds the project and publishes the package to the Github registry. You can install
a published version of the Content CLI using the following command:
We manage releases using Github Actions with the `Build and Publish Workflow`. This action gets executed manually by the Codeowners when there are changes that need to be published.
This builds the project and publishes the package to the Github registry. You can install
the latest published version of the Content CLI using the following command:

```
npm i -g @celonis/content-cli
```

## Contributing

We encourage public contributions! Please review
We encourage public contributions! Please check
[CONTRIBUTING.md](https://github.com/celonis/content-cli/blob/master/CONTRIBUTING.md) for details on our
code of conduct and development process.
code of conduct.

For details on command development, refer to the [How to Add a Command](https://github.com/celonis/content-cli/blob/master/docs/how-to-add-command.md) guide.

## License

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"description": "CLI Tool to help manage content in Celonis EMS",
"main": "content-cli.js",
"bin": {
"content-cli": "./content-cli.js"
"content-cli": "./dist/content-cli.js"
},
"author": "Celonis SE",
"license": "MIT",
Expand Down