Installing Kit
Kit is a command line tool for building and managing secure and shareable ModelKits. It works on Mac, Windows, and Linux computers.
This page includes instructions for:
- Installing on MacOS with Brew or ZIP
- Installing on Windows with ZIP
- Installing on Linux with Brew or TAR
- Building from the source code
🍎 MacOS Install
The simplest way to install Kit on a Mac is with Homebrew. You can also install from ZIP.
Mac Brew Install
- Open a Terminal window
- At the prompt type:
brew tap jozu-ai/kitops
(if that doesn't work use the ZIP instructions - When the previous command completes, type
brew install kitops
You can verify that kit
is correctly installed by opening a new terminal or command prompt and typing:
kit version
This command should display the version number of the Kit CLI you have installed, indicating that the installation was successful.
Now follow our Quick Start to learn how to pack and share your first ModelKit.
Need Help? If something isn't working get help on our Discord channel.
Mac Install from ZIP
There are two generations of Mac hardware, if you aren't sure which you have check here.
MacOS: Apple Silicon / ARM64
MacOS: Intel / x86_64
The Kit download will happen so quickly on a fast connection that you might miss it...
- Open the Mac Finder and check your downloads location for a file that starts with
kitops-darwin
- Double-click the
.zip
file to unpack it - Select the executable file named
kit
from unpacked folder and move it to/usr/local/bin
You can verify that kit
is correctly installed by opening a new terminal or command prompt and typing:
kit version
This command should display the version number of the Kit CLI you have installed, indicating that the installation was successful.
Now follow our Quick Start to learn how to pack and share your first ModelKit.
Need Help? If something isn't working get help on our Discord channel.
🪟 Windows Install
Make sure you get the correct download for your hardware.
Windows: Intel / AMD, 64-bit
Windows: ARM 64-bit
Windows: Intel / AMD, 32-bit
The Kit download will happen so quickly on a fast connection that you might miss it...
- Open the File Explorer and check your downloads location for a file that starts with
kitops-windows
- Right-click the
.zip
file and select "Extract All..." to unzip the archive - Move the extracted
kit.exe
to a directory that is included in your system's PATH variable (this will allow you to run the Kit CLI from anywhere).
You can verify that kit
is correctly installed by opening a new terminal or command prompt and typing:
kit version
This command should display the version number of the Kit CLI you have installed, indicating that the installation was successful.
Now follow our Quick Start to learn how to pack and share your first ModelKit.
Need Help? If something isn't working get help on our Discord channel.
🐧 Linux Install
The simplest way to install Kit on Linux is with Homebrew. You can also install from TAR.
Linux Brew Install
- Open a Terminal window
- At the prompt type:
brew tap jozu-ai/kitops
(if that doesn't work use the TAR instructions - When the previous command completes, type
brew install kitops
You can verify that kit
is correctly installed by opening a new terminal or command prompt and typing:
kit version
This command should display the version number of the Kit CLI you have installed, indicating that the installation was successful.
Now follow our Quick Start to learn how to pack and share your first ModelKit.
Need Help? If something isn't working get help on our Discord channel.
Linux TAR Install
Make sure you get the correct download for your hardware.
Linux: Intel / AMD, AMD 64-bit
Linux: ARM 64-bit
Linux: Intel / AMD, 32-bit
The Kit download will happen so quickly on a fast connection that you might miss it...
Open a terminal window in your downloads location and look for a file that starts with kitops-linux
.
Use the tar
command to extract the downloaded file. For example, if you downloaded the kitops-linux-x86_64.tar.gz
file, you would use the following command:
tar -xzvf kitops-linux-x86_64.tar.gz
Move the extracted kit
executable to a location in your system's PATH. A common choice is /usr/local/bin
. You can do this with the mv
command (this may require administrator privileges):
sudo mv kit /usr/local/bin/
After installation, you can verify that kit
is correctly installed by opening a new terminal or command prompt and typing:
kit version
This command should display the version number of the Kit CLI you have installed, indicating that the installation was successful.
Now follow our Quick Start to learn how to pack and share your first ModelKit.
Need Help? If something isn't working get help on our Discord channel.
🛠️ Build from Source Code
For those who prefer or require building kit
from the source code, this section will guide you through the necessary steps.
Before you begin, make sure you have the following installed on your system:
- Git
- A recent version of 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.
Clone the Repository
First, clone the kitops
GitHub repository to your local machine. Open a terminal and run:
git clone https://github.com/jozu-ai/kitops.git
cd kitops
This command clones the repository and changes your current directory to the cloned repository's root.
Build Sources
Once inside the kitops
directory, you can build the kit
tool using the Go compiler. Run:
go build -o kit
This command compiles the source code into an executable named kit
. If you are on Windows, you might want to name the executable kit.exe
.
Install the Executable
After the build process completes, you need to move the kit
executable to a location in your system's PATH to make it accessible from anywhere in the terminal:
For MacOS and Linux:
sudo mv kit /usr/local/bin/
For Windows:
Move kit.exe
to a directory that's included in your system's PATH variable. This step may vary based on your specific Windows setup.
Verify the Installation
To verify that kit
was installed successfully, open a new terminal window and type:
kit version
Follow the Quick Start
Now that everything is set up you can follow our Quick Start to learn how to pack and share your first ModelKit.
Become a Design Partner
Interested in helping to shape the future of our project? Email feedback@jozu.com to learn more about our Design Partner program.