KubeRocketCI/cli

| :heavy_exclamation_mark: Please refer to the KubeRocketCI documentation to get the notion of the main concepts and guidelines. |
| --- |
krci is the command-line companion for the KubeRocketCI
platform — inspect projects, deployments, pipeline runs, and SonarQube state
straight from the terminal, with JSON output ready for agent workflows.
From chat to fix — CLI + AI agent
krci is built to pair with an AI coding assistant (Claude Code, Cursor,
Copilot CLI, etc.). Every data command emits predictable JSON under
-o json, so an agent can **discover** resources by filter (no hard-coded
names) and then **drill in** — a list → get chain the agent plans on its
own from your natural-language question.
*"Check all my PRs that have failed and analyze the logs"*
*"What's the reason the pipeline is failing on PR 44?"*
*"Build main and tell me the version it produced"*
*"Check quality gates for each of my projects"*
*"Is keycloak-operator healthy right now?"*
Target state
Questions we want the agent to answer next, keeping the same
list-then-drill pattern:
Why this works: the CLI only talks to the KubeRocketCI Portal (no direct
cluster access), tokens stay encrypted on disk, and the JSON shapes are
stable enough to treat krci as a first-class agent tool.
What it does
| Area | What you get | Docs |
|---------------|----------------------------------------------------------------------------------|-------------------------------------------|
| Authentication | OIDC + PKCE browser flow, AES-256-GCM token storage, OS keyring integration | docs/auth.md |
| Projects | List and inspect projects, list their built image versions, build a branch | docs/project.md |
| Deployments | Inspect deployments, their apps, environments, and promotion gates | docs/deployment.md|
| Environments | Inspect envs — deployed apps, infrastructure, gates, health, pods, and events | docs/env.md |
| Pipeline runs | List, filter, stream logs, and diagnose failures across Tekton runs | docs/pipelinerun.md |
| SonarQube | Projects, quality gates, measures, and issues via the Portal's Sonar binding | docs/sonar.md |
| SCA | Dependency-Track projects, dependencies, and vulnerability findings | docs/sca.md |
Every data command accepts -o table (default) or -o json. Tables render
nicely on a TTY, plain text into pipes, JSON for automation.
Install
Or grab a binary from GitHub Releases.
30-second tour
Each command has a --help page. Deeper walk-throughs live in docs/ —
start with the area you care about.
Commands
**Aliases:** project → proj, deployment → dp, env → e, pipelinerun → run
Configuration