Quick Start
Follow the guide below for your specific operating system to get started running a Kuzco worker. Before proceeding, make sure you have compatible hardware.
macOS
Desktop App
The easiest way to get started with Kuzco on macOS is to download and install the Kuzco macOS app from the official website (opens in a new tab).
Launch the app and follow the on-screen instructions to set up your account and launch a worker.
CLI
Kuzco can also be run as a CLI tool on macOS. To install Kuzco CLI, run following command in your terminal:
curl -fsSL https://kuzco.xyz/install.sh | sh
After installation, register your account (opens in a new tab). Make sure to verify your email to complete the registration process.
Next, run the following command to initialize your Kuzco worker:
kuzco init
This command will guide you through creating and running a Kuzco worker.
Windows
Desktop App
The easiest way to get started with Kuzco on Windows is to download and install the Kuzco Windows app from the official website (opens in a new tab).
Launch the app and follow the on-screen instructions to set up your account and launch a worker.
WSL
Kuzco can also be run on Windows Subsystem for Linux (WSL). Check out our WSL guide to get started.
Docker
You can run Kuzco in a Docker container on Windows. Make sure you have:
- Docker Desktop (opens in a new tab) installed
- NVIDIA GPU from our supported hardware list
Follow these steps:
- Register at kuzco.xyz/register (opens in a new tab)
- Verify your email
- Go to "Workers" tab in dashboard
- Click "Create Worker" and select "Docker"
- Copy the Docker command from the Kuzco Console and run it in your Windows terminal to start the container. The command will look similar to this:
docker run --rm --runtime=nvidia --gpus all -e CACHE_DIRECTORY=/root/models -v ~/.kuzco/models:/root/models kuzcoxyz/amd64-ollama-nvidia-worker --worker <unique-worker-id> --code <your-unique-code>
Note: Each worker has its unique ID and code. Always use the command provided in your Kuzco Console.
Your worker will show as "Initializing" in the dashboard. This process usually takes 1-2 minutes.
Linux
Run the following command to install Kuzco on Linux:
curl -fsSL https://kuzco.xyz/install.sh | sh
After installation, register your account (opens in a new tab). Make sure to verify your email to complete the registration process.
Next, run the following command to initialize your Kuzco worker:
kuzco init
This command will guide you through creating and running a Kuzco worker.
Next Steps
- Check out the list of officially supported hardware here (opens in a new tab).
- Join the Kuzco Discord (opens in a new tab) for more information and support.