https://github.com/conductor-oss/conductor-cli
https://github.com/conductor-oss/conductor-cli
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/conductor-oss/conductor-cli
- Owner: conductor-oss
- License: apache-2.0
- Created: 2024-02-27T07:21:31.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-01T06:47:48.000Z (over 1 year ago)
- Last Synced: 2025-01-09T10:43:22.350Z (9 months ago)
- Language: Go
- Size: 29.3 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CLI for Conductor
[Conductor](https://www.conductor-oss.org/) is the leading open-source orchestration platform allowing developers to build highly scalable distributed applications.
Check out the [official documentation for Conductor](https://orkes.io/content).
This repository provides a Java client for the Orkes Conductor Server.
## ⭐ Conductor OSS
Show support for the Conductor OSS. Please help spread the awareness by starring Conductor repo.
[](https://GitHub.com/conductor-oss/conductor/)
## Server Commands
### Work with a server
```shell
# cdt works with the environment variables to connect to the server
export CONDUCTOR_SERVER_URL=http://server:port/api
########################################
### REQUIRED when using Orkes hosted ###
########################################
# When using an Orkes server which requires api key/secret, set the following env variables
export CONDUCTOR_AUTH_KEY=api_key
export CONDUCTOR_AUTH_SECRET=api_key_secret
# Optionally, you can copy the auth token from the conductor UI and export it as such (useful for quick testing)
export CONDUCTOR_AUTH_TOKEN=auth_token
```
## Workflow Metadata Management
```shell
# List the workflows on the server
cdt workflow list
# Get the workflows definition - fetches the latest version
cdt workflow get
# add a version with a comma in the name to get the specific version
cdt workflow get ,
# You can use quotes for workflow name if the name contains spaces, comma or special characters
cdt workflow get ""
```
### Create a workflow
```shell
# Register a workflow stored in the file
cdt workflow create /path/to/workflow_definition.json --force # use --force to overwrite existing
```
## Code Generation
```shell
# Generate a project of type (worker/application) in a particular language from a boilerplate (default is core)
# See https://github.com/conductor-sdk/boilerplates for available boilerplates
ccli code generate -n -l -t -b
```
Example:
```shell
ccli code generate -n myapp -l javascript -t worker
```