KubeRich
Browse documentation

REFERENCE

Capabilities and limits

Generated from the maintained capability inventory for source version 0.1.0. This is an audit of intended scope, not a promise of complete parity. Available means the described behavior works within its documented scope. Partial means usable portions exist, with remaining behavior stated explicitly. Planned features are unavailable. Feature guides describe prerequisites and limits.

Real-provider certification and final release qualification remain separate from implemented local contracts. A locally verified helper is not proof of compatibility with every cloud account or terminal.

Current inventory

All 26 explicitly registered launch flags; help/version/info and completion

Status: partial

Help, version, local diagnostics, read-only policy, presentation flags, startup views and connection overrides are available. Splash, inversion, resource export settings and shell completion are unavailable.

Context/kubeconfig/cluster/user/namespace selection and connection overrides

Status: partial

Select explicit kubeconfig files, context, namespace, cluster/user overrides and connection options. Each context owns its connection and captured delegated identity.

AWS EKS, Azure AKS, GKE and generic exec/OIDC/cert/token credentials

Status: partial

Exec bearer/certificate helpers, token files and explicit native helper login are available. Local provider-shaped tests do not certify real cloud accounts or identity providers. Legacy auth-provider/basic entries require migration.

TLS/CA/client certificates, proxy, request timeout and impersonation

Status: partial

CA/client certificates, TLS names, timeouts, captured proxy settings and repeated impersonation are supported. SOCKS5 has documented streaming limitations. A permission browser is planned.

Context rename/delete and persisted per-context view/namespace preferences

Status: partial

Ordinary context switching preserves kubeconfig. Renaming/deleting contexts and persisted per-context view preferences are planned.

API discovery, resource aliases and dynamic/CRD server columns

Status: partial

Discovery selects served API versions and exposes unambiguous aliases. Generic tables support server columns, metadata fallback and temporary column selection. Generic mutations and relationship jumps are planned.

Live resource updates, manual refresh, retry/reconnect and errors

Status: partial

Live views own bounded list/watch continuity, stale-state retention and reconnect/relist behavior. Refresh renews discovery and the selected resource stream. Complete maximum-workload qualification remains separate.

Resource command mode, aliases, autocomplete, namespace/context arguments

Status: partial

The bordered command bar completes inline from local commands, contexts, namespaces and discovered resources. Tab accepts; arrows choose a candidate. No keystroke-triggered authentication or request is performed.

Regex/inverse/fuzzy filtering, label/field selectors and filter history

Status: partial

Tables support local case-insensitive text and bounded Unicode regular-expression filtering with visible errors. Inverse/fuzzy matching, server selectors and saved filter history are planned.

Status: partial

Bounded session history retains resource kind, scope, filter, sort, selection and viewport. The trail states the Escape destination. Persistent history and wider relationship drill-down are planned.

Keyboard/mouse, horizontal/vertical scrolling, paging, resize and Unicode

Status: partial

Tables support keyboard paging, horizontal scrolling, Unicode, small terminals and retained resource identity. Source/installed PTY and SSH/tmux checks have explicit physical-terminal and clipboard limits.

Typed sorting, movable/custom/wide columns, errors-only and selection ranges

Status: partial

Standard and generic tables sort typed values with stable selection. Generic server columns can be selected/reordered for the session. Persistent layouts, range selection and errors-only filtering are planned.

Help, key hints, header/logo/breadcrumb visibility, fullscreen and quit behavior

Status: partial

The shared header shows current-view shortcuts, with secondary actions in help on small terminals. Per-view user-defined hotkeys are planned.

YAML/describe/details, managedFields toggle, text search and auto-refresh

Status: partial

Selected resources expose captured details, redacted YAML and UID-related events with local search. Inspection is a snapshot; reopen it to refresh. Automatic viewer refresh is planned.

Copy resource/namespace/text with native clipboard and OSC52 over SSH/tmux

Status: partial

Inspection, logs and local shell review offer redacted terminal clipboard output. Actual host receipt depends on OSC52 permissions and SSH/tmux forwarding; native clipboard integration is planned.

Save resources/logs, screen-dump browser and export path settings

Status: partial

Logs can be saved to an explicit new private file without overwrite. A saved-export browser, general resource export and richer export formats are planned.

About/branding and optional update notification

Status: partial

The shared header displays the actual installed version and original KubeRich brand. Optional cached update notices and further presentation controls are planned.

Pods/containers including init and ephemeral containers, events and namespaces

Status: partial

Pods and namespaces have live dedicated views. Pod Enter opens captured regular/init/sidecar container rows; selected-container logs and existing ephemeral attach/file-copy checks have separate scope.

Deployments, StatefulSets, DaemonSets, ReplicaSets, replication controllers, workloads

Status: partial

Standard workload tables and reviewed scale/restart/revision rollback are available for supported controllers. Automatic owner/ReplicaSet drill-down is planned.

Services, Endpoints, EndpointSlices, Ingresses and NetworkPolicies

Status: partial

Service, EndpointSlice, Ingress and NetworkPolicy views are available. Service numeric TCP forwarding has its own prerequisites. Discovery refuses APIs removed from the selected server.

Nodes, PV/PVC, StorageClasses, priority/scheduling, HPA/PDB/quota/limits

Status: partial

Node, PV, PVC, StorageClass and HPA tables are available. Live usage, scheduling overviews and broader quota/disruption diagnostics are planned.

ConfigMaps, Secrets, service accounts and RBAC resource families

Status: partial

ConfigMap, Secret, service-account and RBAC resource tables support ordinary redacted inspection. Secret reveal/edit and a permission browser are unavailable.

Custom resources, unknown APIs and custom columns/jump chains

Status: partial

Discovered custom resources support served versions, server Table columns, typed sorting and captured inspection. Custom mutation, persistent layouts and relationship jumps are planned.

Current/previous logs, container selection and all-container/workload logs

Status: available

Read current/previous container logs, select sources and aggregate supported workload logs. Owned readers track membership and preserve per-source identity.

Head/tail/time windows, timestamps, wrap, follow/pause and column lock

Status: available

Logs support head/tail/time windows, timestamps, wrapping, reception pause and independent viewport following. Retained history is bounded; rotated API output may be unavailable.

Log search/filter, clear, marks, fullscreen, copy/save and bounded buffering

Status: partial

Retained log search, match navigation, marks, clear/fullscreen, redacted copy and exclusive private-file save are available. Richer filtering and saved-export browsing are planned.

Shell exec with chosen container and configurable shell command

Status: partial

A selected container can open an embedded kubectl shell with captured scope and local bounded history/search/copy. Write mode, kubectl and exec permission are required. Advanced terminal protocols are outside the initial scope.

Attach to running containers and bidirectional file transfer

Status: partial

Attach to supported running containers and review bidirectional file/tree transfers. Uploads and attach require write mode; downloads use explicit local destinations and guarded extraction. Interrupted uploads can leave remote files.

Pod/container/service port forwarding, listing, deletion and bind address

Status: partial

Manage pod/Service numeric TCP forwards with explicit bind intent, readiness, listing and stop. Resource/context/exit cleanup owns local processes; external forwards are not discovered.

FastForward annotations, named ports, multiple presets and WebSocket transport

Status: planned

Named ports, FastForward annotations, multiple presets and additional port-forward transports are planned.

Read-only mode, permissions, target validation and dangerous-action gates

Status: partial

Common read-only policy, captured targets, permission handling and one-use confirmations guard effectful operations. Kubernetes RBAC/admission remain authoritative; application read-only mode is not a sandbox.

Edit manifests with external editor and conflict/diff validation

Status: partial

Edit a selected supported manifest using an explicit local-disclosure review, trusted external editor, redacted diff, strict server dry-run and separate Apply. Secret editing is unavailable.

Scale, restart and rollback workloads; deployment ReplicaSet drill-down

Status: partial

Review scale, restart or an explicit retained-revision rollback for supported controllers. Rollout monitoring reports actual controller progress independently of API write confirmation. Owner drill-down is planned.

Delete/force-delete/bulk actions and pod completed/error cleanup

Status: partial

Single/batch deletion reviews identity, grace and propagation, then retains independent partial/uncertain outcomes. It never silently removes finalizers. Automatic completed/error pod cleanup is planned.

Trigger/suspend jobs and CronJobs

Status: available

Review supported Job/CronJob suspend/resume and create an independent manual Job from a captured CronJob template. Scheduled concurrency policy does not govern that manual run.

ConfigMap/Secret content, encoded/decoded toggle and environment provenance

Status: partial

Ordinary ConfigMap/Secret inspection is redacted. Sensitive-content reveal, encoded/decoded toggles and environment provenance views are planned.

Local manifest directories, YAML edit, apply/delete and Kustomize

Status: planned

Local manifest directories, apply/delete workflows and Kustomize integration are planned.

Helm list/status/notes/values/all-values/manifest/history

Status: planned

Helm release browsing, status, notes, values, manifests and history are planned.

Helm rollback and uninstall with history options

Status: planned

Helm rollback and uninstall workflows are planned.

Global/per-context themes, transparent colors, light/dark inversion, icon settings

Status: partial

An original built-in k9s color theme and explicit Textual theme selection are available. Custom user skins, live reload and per-context theme overrides are planned.

Aliases, hotkeys, columns, alignment/width/order, context/resource view overrides

Status: partial

Built-in/discovered aliases and temporary generic column selection are available. User-defined hotkeys, persistent layouts and context/resource view overrides are planned.

Custom GVR relationship jumps with selectors/templates/namespace

Status: planned

Configurable resource relationship jumps with templates, selectors and namespace routing are planned.

Reactive settings reload, paths, feature gates, connection/log/metric thresholds

Status: partial

Preferences are loaded and validated locally. Reactive reload, wider feature gates and connection/log/metric threshold configuration are planned.

Plugin search paths, scopes, shortcut overrides, confirmation and dangerous flag

Status: planned

User plugin search paths, scoped shortcuts, confirmation and dangerous-action handling are planned.

Plugin environment/column/resource expansion and foreground/background execution

Status: planned

User plugin environment/resource expansion and foreground/background execution are planned.

Typed plugin inputs, defaults, validation, cancellation and output options

Status: planned

Typed plugin inputs, defaults, validation and configurable output handling are planned.

Every bundled community plugin workflow and external-tool dependency

Status: planned

Community plugin workflows and their external-tool compatibility are planned; no bundled plugin parity is claimed.

CPU/memory usage, requests/limits/percentages, extended/GPU resources

Status: partial

Container rows show declared CPU/memory requests and limits. Live usage, percentages, GPU/extended resources and metrics views are planned.

Pulse cluster overview and CPU/memory drill-downs

Status: planned

A cluster metrics overview with CPU/memory drill-down is planned.

XRay relationships, jump-to-owner/node, service endpoints and UsedBy

Status: planned

Resource relationship graphs, owner/node jumps, service endpoints and UsedBy views are planned.

RBAC can/user/group/service-account policies and rule inspection

Status: planned

An interactive RBAC permission/rule browser is planned.

Popeye/cluster diagnostic reports and actionable failure evidence

Status: planned

Cluster diagnostic reports and actionable health-check views are planned.

Status: planned

Opt-in image vulnerability scanning and advisory/package/fix views are planned.

Node shell helper pods, configurable image/namespace/limits/host mounts

Status: planned

Node helper-pod shells and configurable host-mount/image/namespace controls are planned.

Cordon/uncordon/drain, disruption constraints and explicit overrides

Status: planned

Reviewed cordon, uncordon and drain with disruption constraints and explicit overrides are planned.

Ephemeral debug containers and diagnostic sessions

Status: planned

Creating ephemeral debug containers and their managed sessions is planned.

HTTP benchmarks, per-context options, results browser and cancellation

Status: planned

HTTP benchmarking, results browsing and benchmark cancellation are planned.

Policy/quota/admission/scheduling views and removed-API handling

Status: partial

Expanded policy, quota, admission and scheduling diagnostics are planned. Discovery already reports removed APIs without fabricating a table.

Linux/macOS downloads, source installs and Homebrew

Status: partial

Local wheel/source and Python-manager installation are verified with separate native archive/Homebrew qualification. Public PyPI, GitHub downloads and the project-owned tap remain unavailable until release activation.

Windows executables, PowerShell, Winget/Scoop/Chocolatey

Status: planned

Windows executables and Windows package-manager channels are planned.

Linux packages, snap, FreeBSD, MacPorts and community package managers

Status: planned

Additional Linux/FreeBSD/MacPorts and community package-manager channels are planned.

OCI terminal image and shell completion

Status: planned

An OCI terminal image and shell completion are planned.

Additional K9sAlpha capabilities beyond the public baseline

Status: unverified

Additional proprietary upstream capabilities lack a verifiable complete public catalogue. They are not claimed as implemented or fully inventoried.

Unreleased upstream fixes/configuration additions after v0.51.0

Status: planned

Unreleased upstream changes are tracked separately from the pinned baseline. They do not establish delivered KubeRich behavior.