Install Kosh

Kosh can be installed in three ways:

Download a prebuilt binary (easiest)
Using go install
Building from source

Download Prebuilt Binary (Easiest)

Prebuilt binaries are available for macOS, Linux, and Windows.

Visit the releases page: Kosh Release Page
Download the appropriate file for your platform, e.g.:
- kosh_Darwin_arm64.tar.gz (macOS Apple Silicon)
- kosh_Darwin_x86_64.tar.gz (macOS Intel)
- kosh_Linux_arm64.tar.gz (Linux ARM)
- kosh_Linux_i386.tar.gz (Linux 32-bit x86)
- kosh_Linux_x86_64.tar.gz (Linux AMD64)
- kosh_Windows_i386.zip (Windows 32-bit x86)
- kosh_Windows_x86_64.zip (Windows AMD64)
Extract the executable from the archive.
Make it executable (macOS/Linux only):
Terminal window
```
chmod +x kosh_*
```
Move it somewhere in your PATH, for example:
Terminal window
```
sudo mv kosh_* /usr/local/bin/kosh
```

Using Go Install (Recommended for Go Users)

The quickest way to install Kosh is:

go install git.plutolab.org/plutolab/kosh@latest

This installs the kosh binary into your Go bin directory (usually ~/go/bin). Make sure this directory is part of your PATH:

export PATH="$PATH:$(go env GOPATH)/bin"

Install from Source

If you want to build Kosh manually or modify the code:

git clone https://git.plutolab.org/plutolab/kosh.git
cd kosh
go build

This will produce a kosh binary in the project root for your current platform.

Verify Installation

Run:

kosh --help

If the installation was successful, you should see:

Kosh is a secure, local vault for storing and generating credentials.

Usage:
  kosh [command]

Available Commands:
  add         Interactively add a new credential to the vault
  completion  Generate the autocompletion script for the specified shell
  delete      Delete an existing credential by ID
  generate    Generate a strong password with specified restrictions
  get         Retrieve credential by exact label and user
  help        Help about any command
  init        Initialize vault with password manager
  list        Show a list of saved credentials
  search      Retrieve a credential via fuzzy search
  update      Update an existing credential by ID

Flags:
  -h, --help   help for kosh

Use "kosh [command] --help" for more information about a command.

Kosh is now ready to use!