conduktor/conduktor-ctl repository overview

⁠Conduktor ctl

This repository contain Conduktor CLI docker image. Conduktor CLI is a command line tool to interact with Conduktor Console. It is strongly inspired by Kubernetes kubectl CLI tool and reuse some of it's concepts.

⁠How to install

⁠From binaries (Linux, MacOS, Windows)

Look for assets of the last release at https://github.com/conduktor/ctl/releases⁠

⁠Using Docker image

How to get the latest docker image:

docker pull conduktor/conduktor-ctl:latest

⁠From source

You will need Go 1.22+ installed and configured on your machine.

To build simply run

go build -o conduktor .

You will find the conduktor binary at the root of the project.

⁠Usage

To run the CLI you will need to provide the Conduktor Console URL and an API access token.

⁠Configure

To use Conduktor CLI, you need to define 2 environment variables:

• The URL of Conduktor Console
• Your API token (either a User Token or Application Token). You can generate an API token on /settings/public-api-keys page of your Console instance.

CDK_BASE_URL=http://localhost:8080
CDK_API_KEY=<admin-token>

⁠Commands Usage

Usage:
  conduktor [command]
Available Commands:
  apply       Upsert a resource on Conduktor
  completion  Generate the autocompletion script for the specified shell
  delete      Delete resource of a given kind and name
  get         Get resource of a given kind
  help        Help about any command
  version     Display the version of conduktor
Flags:
  -h, --help      Help for conduktor
  -v, --verbose   Show more information for debugging

You can find more usage details on our documentation⁠

⁠Contributing

Please read CONTRIBUTING.md⁠ for details on our code of conduct, and the process for submitting pull requests to us.

⁠License

This project is licensed under the Apache 2.0 License - see the LICENSE⁠ file for details.