Installing KitOps β
kit
is the command-line tool for building and managing ModelKits.
Pick your platform to get started:
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...
- Get the ZIP for your Mac chip type.
- MacOS: Apple Silicon / ARM64
- MacOS: Intel / x86_64
- Move the kit executable to
/usr/local/bin
- Test it worked by running
kit version
in your terminal - Verify your installation
πͺ Windows KitOps Install β
- Get the ZIP for your hardware type:
- Windows: Intel / AMD, 64-bit
- Windows: ARM 64-bit
- Windows: Intel / AMD, 32-bit
- Unzip the file using βExtract Allβ¦β
- Move
kit.exe
to a folder in your system PATH - Verify your installation
π§ Linux KitOps Install β
Install with Homebrew (recommended)
brew tap kitops-ml/kitops
brew install kitops
kit version
Or use TAR instead...
- Get the ZIP for your Mac chip type.
- Linux: Intel / AMD, AMD 64-bit
- Linux: ARM 64-bit
- Linux: Intel / AMD, 32-bit
- In a terminal:
tar -xzvf kitops-linux-x86_64.tar.gz sudo mv kit /usr/local/bin/
- 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 executionKITOPS_HOME
environment variable for permanent configurations If theKITOPS_HOME
is set in various places the order of precedence is:--config
flag, if specified$KITOPS_HOME
environment variable, if set- A default OS-dependent value:
- Linux:
$XDG_DATA_HOME/kitops
, falling back to~/.local/share/kitops
- Windows:
%LOCALAPPDATA%\kitops
- MacOS:
~/Library/Caches/kitops
- Linux:
Have feedback or questions? Open an issue on GitHub or join us on Discord.