Commands
Auto-generated documentation of keptn CLI
Home / Docs / Release 0.7.3 / Reference / Keptn CLI
Explains how to download and install the Keptn CLI as well as which commands are available.
Auto-generated documentation of keptn CLI
In this section, the functionality and commands of the Keptn CLI are described. The Keptn CLI allows installing, configuring, and uninstalling Keptn. Furthermore, the CLI allows creating projects, onboarding services, and sending new artifact events.
This works for Linux and Mac only.
This will download the 0.7.3 CLI version from GitHub, unpack it and move it to /usr/local/bin/keptn
.
curl -sL https://get.keptn.sh | sudo -E bash
Verify that the installation has worked and that the version is correct by running:
keptn version
Every release of Keptn provides binaries for the Keptn CLI. These binaries are available for Linux, macOS, and Windows.
Find the keptn
binary in the unpacked directory.
Linux / macOS: Add executable permissions (chmod +x keptn
), and move it to the desired destination (e.g. mv keptn /usr/local/bin/keptn
)
Windows: move/copy the executable to the desired folder and, optionally, add the executable to the PATH environment variable for a more convenient experience.
Verify that the installation has worked and that the version is correct by running:
keptn version
In the following, the commands provided by the Keptn CLI are described. To list all available commands just execute:
keptn --help
All of these commands also support the help flag (--help
), which describes details of the respective command (e.g., usage of the command or description of flags).
To authenticate the Keptn CLI against the Keptn cluster, the exposed Keptn endpoint and API token are required.
api-gateway-nginx
. (If you are using port-forward to expose Keptn, your endpoint is localhost
and the port
you forwarded Keptn to, e.g.: http://localhost:8080
)kubectl -n keptn get service api-gateway-nginx
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
api-gateway-nginx ClusterIP 10.107.0.20 <ENDPOINT_OF_API_GATEWAY> 80/TCP 44m
Note: If you receive a warning Retrive API Token and Authenticate Keptn CLI on Linux / MacOS
KEPTN_ENDPOINT
:KEPTN_ENDPOINT=<ENDPOINT_OF_API_GATEWAY>
KEPTN_API_TOKEN
:KEPTN_API_TOKEN=$(kubectl get secret keptn-api-token -n keptn -ojsonpath={.data.keptn-api-token} | base64 --decode)
keptn auth --endpoint=$KEPTN_ENDPOINT --api-token=$KEPTN_API_TOKEN
Using a file-based storage for the key because the password-store seems to be not set up.
this is because a password store could not be found in your environment. In this case, the credentials are stored in ~/.keptn/.password-store
in your home directory.
Please expand the corresponding section matching your CLI tool: For the Windows PowerShell, a small script is provided that installs the In the Windows Command Line, a couple of steps are necessary. Take the encoded API token - it is the value from the key Decode the file:Retrive API Token and Authenticate Keptn CLI on Windows
PowerShell
PSYaml
module and sets the environment variables.
KEPTN_ENDPOINT
:$Env:KEPTN_ENDPOINT = '<ENDPOINT_OF_API_GATEWAY>'
KEPTN_API_TOKEN
:$tokenEncoded = $(kubectl get secret keptn-api-token -n keptn -ojsonpath='{.data.keptn-api-token}')
$Env:KEPTN_API_TOKEN = [System.Text.Encoding]::UTF8.GetString([System.Convert]::FromBase64String($tokenEncoded))
keptn auth --endpoint=$Env:KEPTN_ENDPOINT --api-token=$Env:KEPTN_API_TOKEN
Command Line
KEPTN_ENDPOINT
:set KEPTN_ENDPOINT=<ENDPOINT_OF_API_GATEWAY>
kubectl get secret keptn-api-token -n keptn -ojsonpath={.data.keptn-api-token}
abcdefghijkladfaea
keptn-api-token
(in this example, it is abcdefghijkladfaea
) and save it in a text file, e.g., keptn-api-token-base64.txt
certutil -decode keptn-api-token-base64.txt keptn-api-token.txt
keptn-api-token.txt
, copy the value and paste it into the next command:set KEPTN_API_TOKEN=keptn-api-token
keptn.exe auth --endpoint=%KEPTN_ENDPOINT% --api-token=%KEPTN_API_TOKEN%