cli

module

v0.1.0 Latest Latest Go to latest Published: Mar 16, 2026 License: Apache-2.0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/KubeRocketCI/cli

Links

Open Source Insights

README ¶

KubeRocketCI CLI

❗ Please refer to the KubeRocketCI documentation to get the notion of the main concepts and guidelines.

Command-line interface for the KubeRocketCI platform — enables developers and AI agents to manage projects, deployments, pipelines, and environments from the terminal.

Overview

krci is a CLI client that interacts with KubeRocketCI platform resources via Kubernetes API. It provides secure OIDC-based authentication with Keycloak and styled terminal output for human users, with JSON output for automation and AI agent workflows.

Features

Authentication — OIDC Authorization Code + PKCE flow with Keycloak, encrypted token storage (AES-256-GCM), OS keyring integration
Projects — List and inspect Codebase resources
Deployments — List and inspect CDPipeline and Stage resources (planned)
Output — Styled tables for terminals, plain text for pipes, JSON for automation

Quick Start

# Authenticate with your KubeRocketCI instance
krci auth login --issuer-url https://your-keycloak/realms/your-realm

# Check auth status
krci auth status

# List projects
krci project list

# Get project details
krci project get my-app

# JSON output for scripting
krci project list -o json

Prerequisites

Go 1.26+ (for building from source)
Access to a KubeRocketCI instance with Keycloak configured

Building

make build

License

Apache License 2.0

Directories ¶

Path	Synopsis
cmd
krci command Package main is the entry point for the krci CLI.	Package main is the entry point for the krci CLI.
internal
auth Package auth provides OIDC authentication for the krci CLI.	Package auth provides OIDC authentication for the krci CLI.
cli Package cli provides Cobra command definitions for the krci CLI.	Package cli provides Cobra command definitions for the krci CLI.
config Package config provides configuration loading for the krci CLI.	Package config provides configuration loading for the krci CLI.
k8s Package k8s provides Kubernetes API access for the krci CLI.	Package k8s provides Kubernetes API access for the krci CLI.
portal Package portal provides a client for the KubeRocketCI Portal public API.	Package portal provides a client for the KubeRocketCI Portal public API.
token Package token provides encrypted token persistence for the krci CLI.	Package token provides encrypted token persistence for the krci CLI.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL