Skip to content

KoalaVim/kv

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

62 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

kv

CLI tool to launch and manage KoalaVim environments.

kv is a single Rust binary that handles launching KoalaVim in different modes, managing isolated virtual environments, keeping plugins in sync via lockfiles, updating KoalaVim, installing dependencies, and running health checks.

Installation

Make sure Cargo is installed (~/.cargo/bin should be in your PATH).

CARGO_NET_GIT_FETCH_WITH_CLI=true cargo install --locked --git=https://github.com/KoalaVim/kv.git

Or build locally:

git clone https://github.com/KoalaVim/kv.git
cd kv
cargo install --locked --path .

Try Without Installing

docker build -t kv .
docker run -it --rm kv

See docs/docker.md for mounting configs, persisting state, and testing features.

Quick Start

# Create the main env with the KoalaConfig starter
kv env create main --from https://github.com/KoalaVim/KoalaConfig.template

# Launch KoalaVim
kv 

Or use the interactive wizard:

kv init

Commands

Command Description Docs
kv [files...] Launch KoalaVim (default) docs/launcher.md
kv env <action> Manage virtual koala envs docs/envs.md
kv lockfile <action> Manage the lazy.nvim lockfile docs/lockfile.md
kv update Update KoalaVim to a target version docs/update.md
kv install Install dependencies into the env docs/install.md
kv health Check health of dependencies docs/health.md
kv init Interactive env setup wizard docs/envs.md
kv completions <shell> Generate shell completions --

All commands respect the --env flag to operate on a specific virtual koala env (default: main).

kv --env myenv              # launch in "myenv"
kv --env myenv health       # check health for "myenv"
kv --env myenv install      # install deps into "myenv"

Shell Completions

kv completions zsh     # generate zsh completions
kv completions bash    # generate bash completions
kv completions fish    # generate fish completions

Platform Support

  • Linux
  • macOS
  • Windows

About

KoalaVim Launcher & Installer

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors