Merge pull request #190 from docker/monorepo-model-cli

Consolidate model-cli into model-runner monorepo

Author: doringeman

.dockerignore

@@ -1,5 +1,4 @@
 # Version control
-.git/
 .gitignore
 
 # IDE and editor files
@@ -73,4 +72,4 @@ Dockerfile*
 .Spotlight-V100
 .Trashes
 
-# Exclude nothing else; keep source code and necessary files for build
+# Exclude nothing else; keep source code and necessary files for build

.github/workflows/cli-build.yml

@@ -0,0 +1,44 @@
+name: Build model-cli
+
+on:
+  push:
+    branches: [ "main" ]
+    paths:
+      - 'cmd/cli/**'
+      - '.github/workflows/cli-build.yml'
+  pull_request:
+    branches: [ "main" ]
+    paths:
+      - 'cmd/cli/**'
+      - '.github/workflows/cli-build.yml'
+  workflow_dispatch:
+    inputs:
+      branch:
+        description: "Branch"
+        required: true
+        default: "main"
+
+jobs:
+  build:
+    runs-on: macos-latest
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version-file: cmd/cli/go.mod
+          cache: true
+          cache-dependency-path: cmd/cli/go.sum
+      - name: Build model-cli
+        working-directory: cmd/cli
+        run: |
+          make release VERSION=${{ github.sha }}
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: |
+            cmd/cli/dist/
+          retention-days: 2
+          if-no-files-found: error

.github/workflows/cli-validate.yml

@@ -0,0 +1,66 @@
+name: Validate model-cli
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - 'main'
+      - 'v[0-9]*'
+    tags:
+      - 'v*'
+    paths:
+      - 'cmd/cli/**'
+      - '.github/workflows/cli-validate.yml'
+  pull_request:
+    paths:
+      - 'cmd/cli/**'
+      - '.github/workflows/cli-validate.yml'
+
+jobs:
+  prepare:
+    runs-on: ubuntu-24.04
+    outputs:
+      targets: ${{ steps.generate.outputs.targets }}
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v4
+      -
+        name: List targets
+        id: generate
+        uses: docker/bake-action/subaction/list-targets@v6
+        with:
+          files: ./cmd/cli/docker-bake.hcl
+          target: validate
+
+  validate:
+    runs-on: ubuntu-24.04
+    needs:
+      - prepare
+    strategy:
+      fail-fast: false
+      matrix:
+        target: ${{ fromJson(needs.prepare.outputs.targets) }}
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v4
+      -
+        name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+        with:
+          buildkitd-flags: --debug
+      -
+        name: Validate
+        uses: docker/bake-action@v6
+        with:
+          files: ./cmd/cli/docker-bake.hcl
+          workdir: ./cmd/cli
+          targets: ${{ matrix.target }}

cmd/cli/.gitignore

@@ -0,0 +1,3 @@
+model-cli
+.idea/
+dist/

cmd/cli/Dockerfile

@@ -0,0 +1,54 @@
+# syntax=docker/dockerfile:1
+
+ARG GO_VERSION=1.24
+ARG ALPINE_VERSION=3.21
+
+ARG DOCS_FORMATS="md,yaml"
+
+FROM --platform=${BUILDPLATFORM} golang:${GO_VERSION}-alpine${ALPINE_VERSION} AS base
+RUN apk add --no-cache rsync git
+ENV CGO_ENABLED=0
+WORKDIR /src
+
+FROM base AS docs-gen
+RUN --mount=target=. \
+    --mount=target=/root/.cache,type=cache \
+    go build -C cmd/cli -o /out/docsgen ./docs/generate.go
+
+FROM base AS docs-build
+COPY --from=docs-gen /out/docsgen /usr/bin
+ENV DOCKER_CLI_PLUGIN_ORIGINAL_CLI_COMMAND="model"
+ARG DOCS_FORMATS
+RUN --mount=target=/context \
+    --mount=target=.,type=tmpfs <<EOT
+  set -e
+  rsync -a --exclude='models-store' /context/. .
+  docsgen --formats "$DOCS_FORMATS" --source "cmd/cli/docs/reference"
+  mkdir /out
+  cp -r cmd/cli/docs/reference/* /out/
+EOT
+
+FROM scratch AS docs-update
+COPY --from=docs-build /out /
+
+FROM docs-build AS docs-validate
+RUN --mount=target=/context \
+    --mount=target=.,type=tmpfs <<EOT
+  set -e
+  rsync -a --exclude='models-store' /context/. .
+  git add -A
+  rm -rf cmd/cli/docs/reference/*
+  cp -rf /out/* ./cmd/cli/docs/reference/
+  if [ -n "$(git status --porcelain -- docs/reference)" ]; then
+    echo >&2 'ERROR: Docs result differs. Please update with "make docs"'
+    git status --porcelain -- cmd/cli/docs/reference
+    exit 1
+  fi
+EOT
+
+FROM base AS test
+RUN apk add --no-cache make gcc musl-dev
+WORKDIR /src
+RUN --mount=target=. \
+  --mount=target=/root/.cache,type=cache \
+  CGO_ENABLED=1 make unit-tests

cmd/cli/Makefile

@@ -0,0 +1,79 @@
+.PHONY: all build clean link mock unit-tests docs
+
+BINARY_NAME=model-cli
+
+PLUGIN_DIR=$(HOME)/.docker/cli-plugins
+PLUGIN_NAME=docker-model
+
+VERSION ?=
+
+MACOS_MIN_VERSION := 14.0
+MACOS_MIN_VERSION_LDFLAG := -mmacosx-version-min=$(MACOS_MIN_VERSION)
+
+all: build
+
+build:
+	@echo "Building $(BINARY_NAME)..."
+	go build -ldflags="-s -w" -o $(BINARY_NAME) .
+
+link:
+	@if [ ! -f $(BINARY_NAME) ]; then \
+		echo "Binary not found, building first..."; \
+		$(MAKE) build; \
+	else \
+		echo "Using existing binary $(BINARY_NAME)"; \
+	fi
+	@echo "Linking $(BINARY_NAME) to Docker CLI plugins directory..."
+	@mkdir -p $(PLUGIN_DIR)
+	@ln -sf $(shell pwd)/$(BINARY_NAME) $(PLUGIN_DIR)/$(PLUGIN_NAME)
+	@echo "Link created: $(PLUGIN_DIR)/$(PLUGIN_NAME)"
+
+install: build link
+
+release:
+	@if [ -z "$(VERSION)" ]; then \
+		echo "Error: VERSION parameter is required. Use: make release VERSION=x.y.z"; \
+		exit 1; \
+	fi
+	@echo "Building release version '$(VERSION)'..."
+	GOOS=darwin GOARCH=arm64 CGO_ENABLED=1 CGO_CFLAGS="$(MACOS_MIN_VERSION_LDFLAG)" CGO_LDFLAGS="$(MACOS_MIN_VERSION_LDFLAG)" go build -trimpath -ldflags="-s -w -X github.com/docker/model-cli/desktop.Version=$(VERSION)" -o dist/darwin-arm64/$(PLUGIN_NAME) .
+	GOOS=windows GOARCH=amd64 go build -trimpath -ldflags="-s -w -X github.com/docker/model-cli/desktop.Version=$(VERSION)" -o dist/windows-amd64/$(PLUGIN_NAME).exe .
+	GOOS=windows GOARCH=arm64 go build -trimpath -ldflags="-s -w -X github.com/docker/model-cli/desktop.Version=$(VERSION)" -o dist/windows-arm64/$(PLUGIN_NAME).exe .
+	CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -trimpath -ldflags="-s -w -X github.com/docker/model-cli/desktop.Version=$(VERSION)" -o dist/linux-amd64/$(PLUGIN_NAME) .
+	CGO_ENABLED=0 GOOS=linux GOARCH=arm64 go build -trimpath -ldflags="-s -w -X github.com/docker/model-cli/desktop.Version=$(VERSION)" -o dist/linux-arm64/$(PLUGIN_NAME) .
+	@echo "Release build complete: $(PLUGIN_NAME) version '$(VERSION)'"
+
+ce-release:
+	@if [ -z "$(VERSION)" ]; then \
+		echo "Error: VERSION parameter is required. Use: make release VERSION=x.y.z"; \
+		exit 1; \
+	fi
+	@if [ "$(uname -s)" != "Linux" ]; then \
+		echo "Warning: This release target is designed for Linux"; \
+	fi
+	@echo "Building local release version '$(VERSION)'..."
+	CGO_ENABLED=0 GOOS=linux go build -trimpath -ldflags="-s -w -X github.com/docker/model-cli/desktop.Version=$(VERSION)" -o dist/$(PLUGIN_NAME) .
+	@echo "Local release build complete: $(PLUGIN_NAME) version '$(VERSION)'"
+
+mock:
+	@echo "Generating mocks..."
+	@mkdir -p mocks
+	@go generate ./...
+	@echo "Mocks generated!"
+
+unit-tests:
+	@echo "Running unit tests..."
+	@go test -race -v ./...
+	@echo "Unit tests completed!"
+
+clean:
+	@echo "Cleaning up..."
+	@rm -f $(BINARY_NAME)
+	@echo "Cleaned!"
+
+docs:
+	$(eval $@_TMP_OUT := $(shell mktemp -d -t model-cli-output.XXXXXXXXXX))
+	docker buildx bake --allow=fs.read=$(shell cd ../.. && pwd) --set "*.output=type=local,dest=$($@_TMP_OUT)" update-docs
+	rm -rf ./docs/reference/*
+	cp -R "$($@_TMP_OUT)"/* ./docs/reference/
+	rm -rf "$($@_TMP_OUT)"/*

cmd/cli/README.md

@@ -0,0 +1,77 @@
+# Docker Model CLI
+
+A powerful command-line interface for managing, running, packaging, and deploying AI/ML models using Docker. This CLI lets you install and control the Docker Model Runner, interact with models, manage model artifacts, and integrate with OpenAI and other backends—all from your terminal.
+
+## Features
+- **Install Model Runner**: Easily set up the Docker Model Runner for local or cloud environments with GPU support.
+- **Run Models**: Execute models with prompts or in interactive chat mode, supporting multiline input and OpenAI-style backends.
+- **List Models**: View all models available locally or via OpenAI, with options for JSON and quiet output.
+- **Package Models**: Convert GGUF files into Docker model OCI artifacts and push them to registries, including license and context size options.
+- **Configure Models**: Set runtime flags and context sizes for models.
+- **Logs & Status**: Stream logs and check the status of the Model Runner and individual models.
+- **Tag, Pull, Push, Remove, Unload**: Full lifecycle management for model artifacts.
+- **Compose & Desktop Integration**: Advanced orchestration and desktop support for model backends.
+
+## Building
+1. **Clone the repo:**
+   ```bash
+   git clone https://github.com/docker/model-cli.git
+   cd model-cli
+   ```
+2. **Build the CLI:**
+   ```bash
+   make build
+   ```
+3. **Install Model Runner:**
+   ```bash
+   ./model install-runner
+   ```
+   Use `--gpu cuda` for GPU support, or `--gpu auto` for automatic detection.
+
+## Usage
+Run `./model --help` to see all commands and options.
+
+### Common Commands
+- `model install-runner` — Install the Docker Model Runner
+- `model run MODEL [PROMPT]` — Run a model with a prompt or enter chat mode
+- `model list` — List available models
+- `model package --gguf <path> --push <target>` — Package and push a model
+- `model logs` — View logs
+- `model status` — Check runner status
+- `model configure MODEL [flags]` — Configure model runtime
+- `model unload MODEL` — Unload a model
+- `model tag SOURCE TARGET` — Tag a model
+- `model pull MODEL` — Pull a model
+- `model push MODEL` — Push a model
+- `model rm MODEL` — Remove a model
+
+## Example: Interactive Chat
+```bash
+./model run llama.cpp "What is the capital of France?"
+```
+Or enter chat mode:
+```bash
+./model run llama.cpp
+Interactive chat mode started. Type '/bye' to exit.
+> """
+Tell me a joke.
+"""
+```
+
+## Advanced
+- **Packaging:**
+  Add licenses and set context size when packaging models for distribution.
+
+## Development
+- **Run unit tests:**
+  ```bash
+  make unit-tests
+  ```
+- **Generate docs:**
+  ```bash
+  make docs
+  ```
+
+## License
+[Apache 2.0](LICENSE)
+

cmd/cli/commands/backend.go

@@ -0,0 +1,43 @@
+package commands
+
+import (
+	"errors"
+	"fmt"
+	"maps"
+	"os"
+	"slices"
+	"strings"
+)
+
+// ValidBackends is a map of valid backends
+var ValidBackends = map[string]bool{
+	"llama.cpp": true,
+	"openai":    true,
+}
+
+// validateBackend checks if the provided backend is valid
+func validateBackend(backend string) error {
+	if !ValidBackends[backend] {
+		return fmt.Errorf("invalid backend '%s'. Valid backends are: %s",
+			backend, ValidBackendsKeys())
+	}
+	return nil
+}
+
+// ensureAPIKey retrieves the API key if needed
+func ensureAPIKey(backend string) (string, error) {
+	if backend == "openai" {
+		apiKey := os.Getenv("OPENAI_API_KEY")
+		if apiKey == "" {
+			return "", errors.New("OPENAI_API_KEY environment variable is required when using --backend=openai")
+		}
+		return apiKey, nil
+	}
+	return "", nil
+}
+
+func ValidBackendsKeys() string {
+	keys := slices.Collect(maps.Keys(ValidBackends))
+	slices.Sort(keys)
+	return strings.Join(keys, ", ")
+}