Skip to content

KubeRocketCI/cli

Repository files navigation

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

Installation

brew tap KubeRocketCI/homebrew-tap
brew install krci

Or download a binary from GitHub Releases.

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

Related Articles

About

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

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors