klim Documentation

Klim is a productivity booster for dev tools. It maps the tools your projects depend on, turns them into portable contracts, and automates install, audit, diff, upgrade, and restore workflows through native package managers.

One binary. Cross-platform. Zero lock-in: every operation delegates to winget, brew, apt, scoop, choco, snap, or npm — the package managers you already trust.

Get started

Install klim One-line installer for macOS, Linux, and Windows. Pre-built binaries, brew tap, Go install, and Linux packages also available.

Quick Start Launch the TUI, list installed tools, run klim check, and import a manifest in five minutes.

What klim does

Interactive TUI Nine tabs covering installed tools, favorites, updates, marketplace discovery, backups, project files, dashboard, configuration, and security health.

Team Manifests (.klim.yaml) Encode required tools and version constraints. klim check validates locally and in CI; klim init scaffolds one from your repo files.

Generate CI / Containers Turn .klim.yaml into a GitHub Actions workflow, Dockerfile, or devcontainer.json — same source, three targets.

Backup & Restore Export your toolchain to a YAML manifest and reinstall everything on a new machine with klim import.

Share via tokens Compact klim:v1:... tokens for chat. Recipients run klim open to install your toolchain.

Env profiles (klim env) Capture the full environment fingerprint: tools, favorites, custom packs, klim version, OS, and audit counts. Diff and apply across machines.

Toolchain history (klim trail) Git-style content-addressed snapshots of your environment. Capture, label, log, show, diff, and prune.

Environment Diff Compare your local toolchain against a manifest, share token, or env profile. Side-by-side output and CI-friendly exit codes.

Security and compliance

Health, audit, vulns, compliance klim security covers PATH issues, archived upstreams, license inventory, OSV-backed CVE/GHSA lookup, and policy enforcement.

Compliance policy Define allowed sources, allowed/blocked licenses, blocked tools, required tools, and a max vulnerability severity threshold.

Vulnerability scan Cross-reference installed versions against OSV.dev for known CVEs and GHSAs. Cached, severity-graded, scriptable.

Environment Score Single 0–100 metric combining tool freshness, doctor health, audit findings, compliance, and managed sources. Grade scale A+ to F, badge for shields.io.

Discovery and automation

Marketplace catalog 110+ curated developer tools across categories. Filter by tag, category, or platform. Curated packs (Cloud Essentials, K8s Starter) bundle related tools.

Onboarding wizard klim onboard scores tools by your dev role (web, devops, data, mobile, systems, security) and installs in one shot.

Try a tool klim try installs temporarily, runs your command, then asks keep-or-remove. Like npx, but for any CLI.

Auto-install shims (proxy) klim proxy add kubectl creates a shim that installs the tool on first run. Lazy installation for tools you might need.

Update watch klim watch reports available updates across the whole toolchain. Cron-friendly with --output json for notification scripts.

Why is this installed? klim why shows where a tool is referenced — projects, packs, related tools, and the package managers that can supply it.

Tool management

Install / upgrade / remove Scriptable, --output json, --dry-run preview, --pack expansion, --source pin. Same command from terminal, CI, and AI agents.

Tool detail (klim info) Every install location, every available package source, GitHub stats, project / pack references, related tools — one screen.

Search klim search ranks the marketplace by name, tag, and description. Use it from the CLI or the TUI's filter sidebar.

Adding tools to the catalog Drop a YAML file in marketplace/tools/ with package IDs and a github slug. CI assembles, GitHub enrichment fills the rest.

Adding curated packs Bundle related tools (e.g. Cloud Essentials) so users install a whole stack with klim install --pack.

Favorites Star tools you care about; the * indicator follows them everywhere. Export favorites as their own manifest or share token.

Shell and CI integration

Shell completions Native tab completion for bash, zsh, fish, and PowerShell. klim completion .

Shell hooks (auto-check on cd) Like nvm/direnv: cd into a project with .klim.yaml and klim quietly tells you about missing or outdated tools.

Configuration config.yaml controls logging, marketplace URL, refresh behaviour, concurrency, and UI preferences. Edit in-TUI or open with klim config edit.

Custom marketplaces Add internal/community marketplace URLs via klim config marketplace add. Tools merge with the default catalog.

CLI reference

The full command reference lives under Commands. Highlights:

• Core: list, update, version, browser
• Project: init, check, generate
• Tools: install, upgrade, remove, info, search, try, onboard, why, watch, diff
• Backup & sharing: export, import, share, open, env, trail
• Health & security: security health, security audit, security vuln, security compliance, score
• Shell integration: shell completion, shell hook, proxy
• Configuration: config, config marketplace