Skip to content
klim

klim env

klim env captures the shape of your klim-managed environment (installed tools, favorites, custom packs, available package managers, klim version, OS, audit/security counts) into a portable artifact you can share via chat or commit to git.

Synopsis

Section titled “Synopsis”
klim env [flags]                   # print compact token to stdout
klim env --output yaml > file.yaml # rich YAML form
klim env show <token-or-file>      # decode + pretty-print
klim env diff <token-or-file>      # diff vs current environment
klim env apply <token-or-file>     # reproduce locally

Privacy

Section titled “Privacy”

A profile contains:

  • installed tools (catalog name, version, install source, category)
  • favorites
  • custom packs you’ve defined (name + tool list)
  • which package managers are available on $PATH
  • klim version + commit
  • OS, architecture, and (best-effort) distro
  • observational audit/security counts (warning/info totals; per-tool clean/watch/risk/unknown bucket counts)

Deliberately not captured:

  • hostname, username
  • absolute paths or any file contents
  • environment variables
  • catalog metadata that would identify the host (no IPs, no ssh fingerprints, etc.)

The artifact is deterministic from environment state alone (modulo generated_at), so passing it to a coworker leaks nothing beyond the inventory above. The hash recorded in the profile is recomputed by klim env diff from the decoded content, so an edited token can’t fake a “matching hash”.

Output formats

Section titled “Output formats”
FlagOutput
(default, or --output text)klim:env:v1:<base64> token, single line, paste-friendly
--output yamlMulti-line YAML document
--output jsonJSON document

A typical 30-tool env produces a token under 1 KB after gzip+base64.

Examples

Section titled “Examples”
Terminal window
# Copy the current env token to the clipboard (macOS).
klim env | pbcopy


# Save the rich YAML for a code review.
klim env --output yaml > my-env.yaml


# Inspect a coworker's token before applying it.
klim env show 'klim:env:v1:H4sIAAAAAAAA...'


# What would change if I applied this?
klim env diff 'klim:env:v1:H4sIAAAAAAAA...'


# Reproduce locally — installs tools that aren't already there,
# adds favorites, registers custom packs.
klim env apply 'klim:env:v1:H4sIAAAAAAAA...'


# Apply from a YAML file with no prompts (CI mode).
klim env apply ./my-env.yaml --yes

What’s in a Profile

Section titled “What’s in a Profile”
schema_version: 1
klim:
  version: v1.2.3
  commit: 97b8857
generated_at: "2026-05-05T17:30:00Z"
hash: f4a7b9c1de32     # first 12 hex of sha256 over canonical payload
                       # (excluding hash + generated_at), so the same
                       # env regenerated still has the same hash


os:
  goos: linux
  arch: amd64
  distro: "Ubuntu 22.04"


package_managers:      # which PM binaries exist on $PATH
  brew: true
  apt: true
  npm: true
  snap: false
  winget: false
  scoop: false
  choco: false


tools:                 # installed tools — name + version + source + category
  - name: jq
    version: "1.7"
    source: brew
    category: CLI


favorites: [fzf, jq, ripgrep]


packs:                 # user's custom packs only (marketplace packs
                       # are supplied by the catalog, not the env)
  - name: my-cli
    tools: [fzf, jq, ripgrep]


security:              # observational; never gates apply
  audit_warnings: 3
  audit_infos: 1
  verdicts:
    clean: 12
    watch: 4
    risk: 1
    unknown: 0

Apply semantics

Section titled “Apply semantics”

klim env apply is best-effort:

  1. Tools — runs the same install plan as klim import; tools already installed locally are skipped, tools without a compatible package manager (e.g. apt-only on Windows) appear in the report as skipped rather than failing.
  2. Favorites — additive merge; never removes existing favorites.
  3. Custom packs — additive; existing packs with the same name are kept; to replace one, edit it out of ~/.klim/marketplace/custom-packs.yaml (or use the TUI’s My Packs tab to delete) and re-run apply.

Cross-OS gaps surface as informational entries, never as errors.

Exit codes

Section titled “Exit codes”
CodeMeaning
0Success (or nothing to do)
1Runtime failure (file I/O, scan, internal error)
2Usage error: missing/invalid arg, or malformed token — invalid prefix, unknown schema version, oversize, corrupt base64/gzip/yaml, schema-version mismatch
3Partial failure — some installs failed but others succeeded
Section titled “Related”