https://github.com/cert-manager/cmctl
`cmctl` or `kubectl cert-manager` is the command line utility that makes cert-manager'ing easier.
https://github.com/cert-manager/cmctl
cert-manager command-line-tool
Last synced: 6 months ago
JSON representation
`cmctl` or `kubectl cert-manager` is the command line utility that makes cert-manager'ing easier.
- Host: GitHub
- URL: https://github.com/cert-manager/cmctl
- Owner: cert-manager
- License: apache-2.0
- Created: 2024-01-12T16:47:35.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-25T22:28:47.000Z (8 months ago)
- Last Synced: 2024-10-29T18:38:41.113Z (7 months ago)
- Topics: cert-manager, command-line-tool
- Language: Go
- Homepage: https://cert-manager.io/docs/reference/cmctl/
- Size: 824 KB
- Stars: 37
- Watchers: 4
- Forks: 8
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cmctl - The cert-manager Command Line Tool
`cmctl` is a command line tool that can help you manage cert-manager and its resources inside your cluster.
## Documentation
The documentation for `cmctl` can be found on the [cert-manager website](https://cert-manager.io/docs/usage/cmctl/).
## Installation
> [!Note]
> These instructions are a copy of the [official installation instructions](https://cert-manager.io/docs/usage/cmctl/#installation).
### Homebrew
On Mac or Linux if you have [Homebrew](https://brew.sh/) installed, you can install `cmctl` with:
```sh
brew install cmctl
```
This will also install shell completion.
### Go install
If you have Go installed, you can install `cmctl` with:
```sh
go install github.com/cert-manager/cmctl/v2@latest
```
### Manual Installation
You need the `cmctl` file for the platform you're using, these can be found on our [cmctl GitHub releases page](https://github.com/cert-manager/cmctl/releases).
In order to use `cmctl` you need its binary to be accessible under the name `cmctl` in your `$PATH`. Run the following commands to set up the CLI. Replace OS and ARCH with your systems equivalents:
```sh
OS=$(uname -s | tr A-Z a-z); ARCH=$(uname -m | sed 's/x86_64/amd64/' | sed 's/aarch64/arm64/'); curl -fsSL -o cmctl https://github.com/cert-manager/cmctl/releases/latest/download/cmctl_${OS}_${ARCH}
chmod +x cmctl
sudo mv cmctl /usr/local/bin
# or `sudo mv cmctl /usr/local/bin/kubectl-cert_manager` to use `kubectl cert-manager` instead.
```
### Shell Completion
`cmctl` supports shell completion for most popular shells. To get help on how to enable shell completion, run the following commands:
```sh
$ cmctl completion --help
# or `kubectl cert-manager completion --help`
...
Available Commands:
bash Generate cert-manager CLI scripts for a Bash shell
fish Generate cert-manager CLI scripts for a Fish shell
powershell Generate cert-manager CLI scripts for a PowerShell shell
zsh Generation cert-manager CLI scripts for a ZSH shell
$ cmctl completion bash --help
To load completions:
Bash:
$ source <(cmctl completion bash)
# To load completions for each session, execute once:
# Linux:
$ cmctl completion bash > /etc/bash_completion.d/cmctl
# macOS:
$ cmctl completion bash > /usr/local/etc/bash_completion.d/cmctl
...
```
## Versioning
Before v2, `cmctl` was located in the cert-manager repository and versioned together with cert-manager.
Starting from v2, `cmctl` is versioned seperately from cert-manager itself.
## Release Process
The release process is documented in [RELEASE.md](RELEASE.md).