diff --git a/tools/jules.md b/tools/jules.md new file mode 100644 index 0000000..e4b0e14 --- /dev/null +++ b/tools/jules.md @@ -0,0 +1,541 @@ +# How to work with the Ollama Bash Lib repository + +This document provides instructions for me, Jules, on how to work with the Ollama Bash Lib repository. + +## General Guidance + +I should always keep this file (`tools/jules.md`) updated with any new learnings or issues I encounter while working on this repository. This will help my future self to be more effective. + +## Code Structure + +The main logic of this repository is contained in the `ollama_bash_lib.sh` file. When modifying the code, I should be aware of the following structure: + +* **Header**: Contains metadata about the library. +* **Global Variables**: `OLLAMA_LIB_*` variables that control the library's behavior. +* **Internal Functions**: Helper functions prefixed with `_`. These are not meant for external use. +* **Public API Functions**: These are the main functions of the library, grouped by category (API, Generate, Chat, etc.). +* **Aliases**: Short aliases for public functions. + +When adding new public functions, I should also consider adding a corresponding alias for it at the end of the file. + +## Code Style and Linting + +To maintain code quality, I should run `shellcheck` on any shell scripts that I create or modify. + +### Installing shellcheck + +I can install `shellcheck` using the package manager for the system. + +For Debian/Ubuntu-based systems: +```bash +sudo apt-get update && sudo apt-get install -y shellcheck +``` + +For Fedora/CentOS/RHEL-based systems: +```bash +sudo dnf install -y shellcheck +``` + +### Running shellcheck + +To check a script, I can run the following command: +```bash +shellcheck .sh +``` + +I should aim to resolve all warnings and errors reported by `shellcheck`. + +## Working with Demos + +The `demos` directory contains a collection of scripts that demonstrate the functionality of the library. + +* The `run.demos.sh` script executes all demo scripts (`.sh` files) and saves their output to corresponding `.md` files. +* To add a new demo, I should create a new `.sh` file in the `demos` directory. This script should showcase a specific feature of the library. +* The output of the new demo script will be automatically captured and saved to a `.md` file with the same name when `run.demos.sh` is executed. + +## Working with Tests + +This repository does not currently have a `tests` directory. If I need to add tests, I should follow these steps: + +1. Create a `tests` directory in the root of the repository. +2. Inside the `tests` directory, create a new `.bats` file for the tests (e.g., `test_chat.bats`). +3. Write the tests using the Bats testing framework. I should source the `ollama_bash_lib.sh` file in my test scripts to access its functions. +4. To run the tests, I can use the `bats` command: `bats tests/`. + +## Testing with Different Bash Versions + +This library must be compatible with Bash v3.2. I should also test with newer versions like v4 and v5 to ensure continued compatibility. + +### Installing Different Bash Versions + +To install a specific version of Bash, I can compile it from source. Here are the general steps: + +1. Create a temporary directory for the build (e.g., `~/bash_build`). +2. Download the source code for the desired Bash version from the GNU FTP server: `http://ftp.gnu.org/gnu/bash/`. For example, for Bash 3.2.57: + ```bash + wget http://ftp.gnu.org/gnu/bash/bash-3.2.57.tar.gz + ``` +3. Extract the downloaded tarball: + ```bash + tar -xzf bash-3.2.57.tar.gz + ``` +4. Navigate into the extracted directory: + ```bash + cd bash-3.2.57 + ``` +5. Configure and compile the source code: + ```bash + ./configure && make + ``` +6. The compiled `bash` binary will be available in the current directory. + +### Running Tests with a Specific Bash Version + +To run a script with a specific version of Bash, I can use the full path to the compiled binary: + +```bash +/path/to/bash-3.2.57/bash my_script_to_test.sh +``` + +When running tests with Bats, I should ensure that the shebang of the test files points to the correct Bash executable, or I can invoke the tests with the specific bash version. + +## Installation + +### Installing Ollama + +When I need to install Ollama for testing purposes, I will create a file named `install_ollama.sh`, add the content from the "Ollama Installation Script" section below, and then execute it. + +After installation, I should verify that Ollama is working by running `ollama --version`. + +### Installing Bats + +When I need to install the Bats testing framework, I will create a file named `install_bats.sh`, add the content from the "Bats Installation Script" section below, and then execute it with the desired prefix (e.g., `/usr/local`). + +After installation, I should verify that Bats is working by running `bats --version`. + +## Cleanup After Installation + +After successfully installing dependencies, I should remove any temporary files or directories that were created during the installation process. This includes any downloaded scripts or archives. + +## Troubleshooting Known Issues + +### Bats Installation Error + +I have previously encountered a persistent internal error when trying to clone the `bats-core` repository or download it as a zip file. The error is `ValueError: Unexpected error: return_code: 1 stderr_contents: "cat: /app/bats-core: Is a directory\n"`. This seems to be a tooling issue. Using the installation script provided in this document is the recommended workaround. If this issue persists, I should inform the user. + +--- + +## Installation Scripts + +### Ollama Installation Script + +```bash +#!/bin/sh +# This script installs Ollama on Linux. +# It detects the current operating system architecture and installs the appropriate version of Ollama. + +set -eu + +red="$( (/usr/bin/tput bold || :; /usr/bin/tput setaf 1 || :) 2>&-)" +plain="$( (/usr/bin/tput sgr0 || :) 2>&-)" + +status() { echo ">>> $*" >&2; } +error() { echo "${red}ERROR:${plain} $*"; exit 1; } +warning() { echo "${red}WARNING:${plain} $*"; } + +TEMP_DIR=$(mktemp -d) +cleanup() { rm -rf $TEMP_DIR; } +trap cleanup EXIT + +available() { command -v $1 >/dev/null; } +require() { + local MISSING='' + for TOOL in $*; do + if ! available $TOOL; then + MISSING="$MISSING $TOOL" + fi + done + + echo $MISSING +} + +[ "$(uname -s)" = "Linux" ] || error 'This script is intended to run on Linux only.' + +ARCH=$(uname -m) +case "$ARCH" in + x86_64) ARCH="amd64" ;; + aarch64|arm64) ARCH="arm64" ;; + *) error "Unsupported architecture: $ARCH" ;; +esac + +IS_WSL2=false + +KERN=$(uname -r) +case "$KERN" in + *icrosoft*WSL2 | *icrosoft*wsl2) IS_WSL2=true;; + *icrosoft) error "Microsoft WSL1 is not currently supported. Please use WSL2 with 'wsl --set-version 2'" ;; + *) ;; +esac + +VER_PARAM="${OLLAMA_VERSION:+?version=$OLLAMA_VERSION}" + +SUDO= +if [ "$(id -u)" -ne 0 ]; then + # Running as root, no need for sudo + if ! available sudo; then + error "This script requires superuser permissions. Please re-run as root." + fi + + SUDO="sudo" +fi + +NEEDS=$(require curl awk grep sed tee xargs) +if [ -n "$NEEDS" ]; then + status "ERROR: The following tools are required but missing:" + for NEED in $NEEDS; do + echo " - $NEED" + done + exit 1 +fi + +for BINDIR in /usr/local/bin /usr/bin /bin; do + echo $PATH | grep -q $BINDIR && break || continue +done +OLLAMA_INSTALL_DIR=$(dirname ${BINDIR}) + +if [ -d "$OLLAMA_INSTALL_DIR/lib/ollama" ] ; then + status "Cleaning up old version at $OLLAMA_INSTALL_DIR/lib/ollama" + $SUDO rm -rf "$OLLAMA_INSTALL_DIR/lib/ollama" +fi +status "Installing ollama to $OLLAMA_INSTALL_DIR" +$SUDO install -o0 -g0 -m755 -d $BINDIR +$SUDO install -o0 -g0 -m755 -d "$OLLAMA_INSTALL_DIR/lib/ollama" +status "Downloading Linux ${ARCH} bundle" +curl --fail --show-error --location --progress-bar \ + "https://ollama.com/download/ollama-linux-${ARCH}.tgz${VER_PARAM}" | \ + $SUDO tar -xzf - -C "$OLLAMA_INSTALL_DIR" + +if [ "$OLLAMA_INSTALL_DIR/bin/ollama" != "$BINDIR/ollama" ] ; then + status "Making ollama accessible in the PATH in $BINDIR" + $SUDO ln -sf "$OLLAMA_INSTALL_DIR/ollama" "$BINDIR/ollama" +fi + +# Check for NVIDIA JetPack systems with additional downloads +if [ -f /etc/nv_tegra_release ] ; then + if grep R36 /etc/nv_tegra_release > /dev/null ; then + status "Downloading JetPack 6 components" + curl --fail --show-error --location --progress-bar \ + "https://ollama.com/download/ollama-linux-${ARCH}-jetpack6.tgz${VER_PARAM}" | \ + $SUDO tar -xzf - -C "$OLLAMA_INSTALL_DIR" + elif grep R35 /etc/nv_tegra_release > /dev/null ; then + status "Downloading JetPack 5 components" + curl --fail --show-error --location --progress-bar \ + "https://ollama.com/download/ollama-linux-${ARCH}-jetpack5.tgz${VER_PARAM}" | \ + $SUDO tar -xzf - -C "$OLLAMA_INSTALL_DIR" + else + warning "Unsupported JetPack version detected. GPU may not be supported" + fi +fi + +install_success() { + status 'The Ollama API is now available at 127.0.0.1:11434.' + status 'Install complete. Run "ollama" from the command line.' +} +trap install_success EXIT + +# Everything from this point onwards is optional. + +configure_systemd() { + if ! id ollama >/dev/null 2>&1; then + status "Creating ollama user..." + $SUDO useradd -r -s /bin/false -U -m -d /usr/share/ollama ollama + fi + if getent group render >/dev/null 2>&1; then + status "Adding ollama user to render group..." + $SUDO usermod -a -G render ollama + fi + if getent group video >/dev/null 2>&1; then + status "Adding ollama user to video group..." + $SUDO usermod -a -G video ollama + fi + + status "Adding current user to ollama group..." + $SUDO usermod -a -G ollama $(whoami) + + status "Creating ollama systemd service..." + cat </dev/null +[Unit] +Description=Ollama Service +After=network-online.target + +[Service] +ExecStart=$BINDIR/ollama serve +User=ollama +Group=ollama +Restart=always +RestartSec=3 +Environment="PATH=$PATH" + +[Install] +WantedBy=default.target +EOF + SYSTEMCTL_RUNNING="$(systemctl is-system-running || true)" + case $SYSTEMCTL_RUNNING in + running|degraded) + status "Enabling and starting ollama service..." + $SUDO systemctl daemon-reload + $SUDO systemctl enable ollama + + start_service() { $SUDO systemctl restart ollama; } + trap start_service EXIT + ;; + *) + warning "systemd is not running" + if [ "$IS_WSL2" = true ]; then + warning "see https://learn.microsoft.com/en-us/windows/wsl/systemd#how-to-enable-systemd to enable it" + fi + ;; + esac +} + +if available systemctl; then + configure_systemd +fi + +# WSL2 only supports GPUs via nvidia passthrough +# so check for nvidia-smi to determine if GPU is available +if [ "$IS_WSL2" = true ]; then + if available nvidia-smi && [ -n "$(nvidia-smi | grep -o "CUDA Version: [0-9]*\.[0-9]*")" ]; then + status "Nvidia GPU detected." + fi + install_success + exit 0 +fi + +# Don't attempt to install drivers on Jetson systems +if [ -f /etc/nv_tegra_release ] ; then + status "NVIDIA JetPack ready." + install_success + exit 0 +fi + +# Install GPU dependencies on Linux +if ! available lspci && ! available lshw; then + warning "Unable to detect NVIDIA/AMD GPU. Install lspci or lshw to automatically detect and install GPU dependencies." + exit 0 +fi + +check_gpu() { + # Look for devices based on vendor ID for NVIDIA and AMD + case $1 in + lspci) + case $2 in + nvidia) available lspci && lspci -d '10de:' | grep -q 'NVIDIA' || return 1 ;; + amdgpu) available lspci && lspci -d '1002:' | grep -q 'AMD' || return 1 ;; + esac ;; + lshw) + case $2 in + nvidia) available lshw && $SUDO lshw -c display -numeric -disable network | grep -q 'vendor: .* \[10DE\]' || return 1 ;; + amdgpu) available lshw && $SUDO lshw -c display -numeric -disable network | grep -q 'vendor: .* \[1002\]' || return 1 ;; + esac ;; + nvidia-smi) available nvidia-smi || return 1 ;; + esac +} + +if check_gpu nvidia-smi; then + status "NVIDIA GPU installed." + exit 0 +fi + +if ! check_gpu lspci nvidia && ! check_gpu lshw nvidia && ! check_gpu lspci amdgpu && ! check_gpu lshw amdgpu; then + install_success + warning "No NVIDIA/AMD GPU detected. Ollama will run in CPU-only mode." + exit 0 +fi + +if check_gpu lspci amdgpu || check_gpu lshw amdgpu; then + status "Downloading Linux ROCm ${ARCH} bundle" + curl --fail --show-error --location --progress-bar \ + "https://ollama.com/download/ollama-linux-${ARCH}-rocm.tgz${VER_PARAM}" | \ + $SUDO tar -xzf - -C "$OLLAMA_INSTALL_DIR" + + install_success + status "AMD GPU ready." + exit 0 +fi + +CUDA_REPO_ERR_MSG="NVIDIA GPU detected, but your OS and Architecture are not supported by NVIDIA. Please install the CUDA driver manually https://docs.nvidia.com/cuda/cuda-installation-guide-linux/" +# ref: https://docs.nvidia.com/cuda/cuda-installation-guide-linux/index.html#rhel-7-centos-7 +# ref: https://docs.nvidia.com/cuda/cuda-installation-guide-linux/index.html#rhel-8-rocky-8 +# ref: https://docs.nvidia.com/cuda/cuda-installation-guide-linux/index.html#rhel-9-rocky-9 +# ref: https://docs.nvidia.com/cuda/cuda-installation-guide-linux/index.html#fedora +install_cuda_driver_yum() { + status 'Installing NVIDIA repository...' + + case $PACKAGE_MANAGER in + yum) + $SUDO $PACKAGE_MANAGER -y install yum-utils + if curl -I --silent --fail --location "https://developer.download.nvidia.com/compute/cuda/repos/$1$2/$(uname -m | sed -e 's/aarch64/sbsa/')/cuda-$1$2.repo" >/dev/null ; then + $SUDO $PACKAGE_MANAGER-config-manager --add-repo https://developer.download.nvidia.com/compute/cuda/repos/$1$2/$(uname -m | sed -e 's/aarch64/sbsa/')/cuda-$1$2.repo + else + error $CUDA_REPO_ERR_MSG + fi + ;; + dnf) + if curl -I --silent --fail --location "https://developer.download.nvidia.com/compute/cuda/repos/$1$2/$(uname -m | sed -e 's/aarch64/sbsa/')/cuda-$1$2.repo" >/dev/null ; then + $SUDO $PACKAGE_MANAGER config-manager --add-repo https://developer.download.nvidia.com/compute/cuda/repos/$1$2/$(uname -m | sed -e 's/aarch64/sbsa/')/cuda-$1$2.repo + else + error $CUDA_REPO_ERR_MSG + fi + ;; + esac + + case $1 in + rhel) + status 'Installing EPEL repository...' + # EPEL is required for third-party dependencies such as dkms and libvdpau + $SUDO $PACKAGE_MANAGER -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-$2.noarch.rpm || true + ;; + esac + + status 'Installing CUDA driver...' + + if [ "$1" = 'centos' ] || [ "$1$2" = 'rhel7' ]; then + $SUDO $PACKAGE_MANAGER -y install nvidia-driver-latest-dkms + fi + + $SUDO $PACKAGE_MANAGER -y install cuda-drivers +} + +# ref: https://docs.nvidia.com/cuda/cuda-installation-guide-linux/index.html#ubuntu +# ref: https://docs.nvidia.com/cuda/cuda-installation-guide-linux/index.html#debian +install_cuda_driver_apt() { + status 'Installing NVIDIA repository...' + if curl -I --silent --fail --location "https://developer.download.nvidia.com/compute/cuda/repos/$1$2/$(uname -m | sed -e 's/aarch64/sbsa/')/cuda-keyring_1.1-1_all.deb" >/dev/null ; then + curl -fsSL -o $TEMP_DIR/cuda-keyring.deb https://developer.download.nvidia.com/compute/cuda/repos/$1$2/$(uname -m | sed -e 's/aarch64/sbsa/')/cuda-keyring_1.1-1_all.deb + else + error $CUDA_REPO_ERR_MSG + fi + + case $1 in + debian) + status 'Enabling contrib sources...' + $SUDO sed 's/main/contrib/' < /etc/apt/sources.list | $SUDO tee /etc/apt/sources.list.d/contrib.list > /dev/null + if [ -f "/etc/apt/sources.list.d/debian.sources" ]; then + $SUDO sed 's/main/contrib/' < /etc/apt/sources.list.d/debian.sources | $SUDO tee /etc/apt/sources.list.d/contrib.sources > /dev/null + fi + ;; + esac + + status 'Installing CUDA driver...' + $SUDO dpkg -i $TEMP_DIR/cuda-keyring.deb + $SUDO apt-get update + + [ -n "$SUDO" ] && SUDO_E="$SUDO -E" || SUDO_E= + DEBIAN_FRONTEND=noninteractive $SUDO_E apt-get -y install cuda-drivers -q +} + +if [ ! -f "/etc/os-release" ]; then + error "Unknown distribution. Skipping CUDA installation." +fi + +. /etc/os-release + +OS_NAME=$ID +OS_VERSION=$VERSION_ID + +PACKAGE_MANAGER= +for PACKAGE_MANAGER in dnf yum apt-get; do + if available $PACKAGE_MANAGER; then + break + fi +done + +if [ -z "$PACKAGE_MANAGER" ]; then + error "Unknown package manager. Skipping CUDA installation." +fi + +if ! check_gpu nvidia-smi || [ -z "$(nvidia-smi | grep -o "CUDA Version: [0-9]*\.[0-9]*")" ]; then + case $OS_NAME in + centos|rhel) install_cuda_driver_yum 'rhel' $(echo $OS_VERSION | cut -d '.' -f 1) ;; + rocky) install_cuda_driver_yum 'rhel' $(echo $OS_VERSION | cut -c1) ;; + fedora) [ $OS_VERSION -lt '39' ] && install_cuda_driver_yum $OS_NAME $OS_VERSION || install_cuda_driver_yum $OS_NAME '39';; + amzn) install_cuda_driver_yum 'fedora' '37' ;; + debian) install_cuda_driver_apt $OS_NAME $OS_VERSION ;; + ubuntu) install_cuda_driver_apt $OS_NAME $(echo $OS_VERSION | sed 's/\.//') ;; + *) exit ;; + esac +fi + +if ! lsmod | grep -q nvidia || ! lsmod | grep -q nvidia_uvm; then + KERNEL_RELEASE="$(uname -r)" + case $OS_NAME in + rocky) $SUDO $PACKAGE_MANAGER -y install kernel-devel kernel-headers ;; + centos|rhel|amzn) $SUDO $PACKAGE_MANAGER -y install kernel-devel-$KERNEL_RELEASE kernel-headers-$KERNEL_RELEASE ;; + fedora) $SUDO $PACKAGE_MANAGER -y install kernel-devel-$KERNEL_RELEASE ;; + debian|ubuntu) $SUDO apt-get -y install linux-headers-$KERNEL_RELEASE ;; + *) exit ;; + esac + + NVIDIA_CUDA_VERSION=$($SUDO dkms status | awk -F: '/added/ { print $1 }') + if [ -n "$NVIDIA_CUDA_VERSION" ]; then + $SUDO dkms install $NVIDIA_CUDA_VERSION + fi + + if lsmod | grep -q nouveau; then + status 'Reboot to complete NVIDIA CUDA driver install.' + exit 0 + fi + + $SUDO modprobe nvidia + $SUDO modprobe nvidia_uvm +fi + +# make sure the NVIDIA modules are loaded on boot with nvidia-persistenced +if available nvidia-persistenced; then + $SUDO touch /etc/modules-load.d/nvidia.conf + MODULES="nvidia nvidia-uvm" + for MODULE in $MODULES; do + if ! grep -qxF "$MODULE" /etc/modules-load.d/nvidia.conf; then + echo "$MODULE" | $SUDO tee -a /etc/modules-load.d/nvidia.conf > /dev/null + fi + done +fi + +status "NVIDIA GPU ready." +install_success +``` + +### Bats Installation Script + +```bash +#!/usr/bin/env bash + +set -e + +BATS_ROOT="${0%/*}" +PREFIX="${1%/}" +LIBDIR="${2:-lib}" + +if [[ -z "$PREFIX" ]]; then + printf '%s\n' \ + "usage: $0 [base_libdir]" \ + " e.g. $0 /usr/local" \ + " $0 /usr/local lib64" >&2 + exit 1 +fi + +install -d -m 755 "$PREFIX"/{bin,libexec/bats-core,"${LIBDIR}"/bats-core,share/man/man{1,7}} + +install -m 755 "$BATS_ROOT/bin"/* "$PREFIX/bin" +install -m 755 "$BATS_ROOT/libexec/bats-core"/* "$PREFIX/libexec/bats-core" +install -m 755 "$BATS_ROOT/lib/bats-core"/* "$PREFIX/${LIBDIR}/bats-core" +install -m 644 "$BATS_ROOT/man/bats.1" "$PREFIX/share/man/man1" +install -m 644 "$BATS_ROOT/man/bats.7" "$PREFIX/share/man/man7" + +read -rd '' BATS_EXE_CONTENTS <"$PREFIX/bin/bats" || true +BATS_EXE_CONTENTS=${BATS_EXE_CONTENTS/"BATS_BASE_LIBDIR=lib"/"BATS_BASE_LIBDIR=${LIBDIR}"} +printf "%s" "$BATS_EXE_CONTENTS" >| "$PREFIX/bin/bats" + +echo "Installed Bats to $PREFIX/bin/bats" +```