Installing KitOps

kit is the command-line tool for building and managing ModelKits.

Pick your platform to get started:

• MacOS
• Windows
• Linux
• Build from source

Need help? Join the community on Discord.

🍎 MacOS KitOps Install

Install with Homebrew (recommended)

brew tap kitops-ml/kitops
brew install kitops

➡️ Verify your installation

Or use ZIP instead...

1. Get the ZIP for your Mac chip type.
   • MacOS: Apple Silicon / ARM64
   • MacOS: Intel / x86_64
2. Move the kit executable to /usr/local/bin
3. Test it worked by running kit version in your terminal
4. Verify your installation

🪟 Windows KitOps Install

1. Get the ZIP for your hardware type:
   • Windows: Intel / AMD, 64-bit
   • Windows: ARM 64-bit
   • Windows: Intel / AMD, 32-bit
2. Unzip the file using “Extract All…”
3. Move kit.exe to a folder in your system PATH
4. Verify your installation

🐧 Linux KitOps Install

Install with Homebrew (recommended)

brew tap kitops-ml/kitops
brew install kitops
kit version

Or use TAR instead...

1. Get the ZIP for your Mac chip type.
   • Linux: Intel / AMD, AMD 64-bit
   • Linux: ARM 64-bit
   • Linux: Intel / AMD, 32-bit
2. In a terminal:

   tar -xzvf kitops-linux-x86_64.tar.gz
   sudo mv kit /usr/local/bin/

3. Verify your installation

Verify the KitOps Installation

After install, open a new terminal and run:

kit version

If Kit is installed correctly, you'll see a kit version printed.

Next Step: Use KitOps

You’re ready to go. Head to our Quick Start guide to:

• Create your first Kitfile
• Pack a model
• Push to a registry

➡️ Get Started tutorial

Build KitOps from Source

If you'd rather build from source you'll need:

• Git
• Go

You can check if you have Go installed by running go version in your terminal. If you need to install Go, visit the official Go download page for instructions.

Steps:

1. Clone and build the project

git clone https://github.com/kitops-ml/kitops.git
cd kitops
go build -o kit

This command compiles the source code into an executable named kit. If you are on Windows, consider renaming the executable to kit.exe.

2. Move the binary:

• macOS/Linux: sudo mv kit /usr/local/bin/
• Windows: move kit.exe to a folder in your PATH

3. Verify the installation

Open a new terminal and run: kit version

You should see your kit version number printed in the terminal.

4. Optional environment settings

You can configure which directory credentials and storage are located:

• --config flag for a specific kit CLI execution
• KITOPS_HOME environment variable for permanent configurations If the KITOPS_HOME is set in various places the order of precedence is:
  1. --config flag, if specified
  2. $KITOPS_HOME environment variable, if set
  3. A default OS-dependent value:
     • Linux: $XDG_DATA_HOME/kitops, falling back to ~/.local/share/kitops
     • Windows: %LOCALAPPDATA%\kitops
     • MacOS: ~/Library/Caches/kitops

---

Have feedback or questions? Open an issue on GitHub or join us on Discord.