cmd.go 35.2 KB
Newer Older
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1
2
3
package cmd

import (
4
	"archive/zip"
Michael Yang's avatar
Michael Yang committed
5
	"bufio"
Michael Yang's avatar
Michael Yang committed
6
	"bytes"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
7
	"context"
8
9
	"crypto/ed25519"
	"crypto/rand"
Michael Yang's avatar
Michael Yang committed
10
	"crypto/sha256"
11
	"encoding/pem"
Michael Yang's avatar
Michael Yang committed
12
	"errors"
Bruce MacDonald's avatar
Bruce MacDonald committed
13
	"fmt"
Michael Yang's avatar
Michael Yang committed
14
	"io"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
15
	"log"
16
	"math"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
17
	"net"
18
	"net/http"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
19
	"os"
20
	"os/signal"
21
	"path/filepath"
22
	"regexp"
23
	"runtime"
Michael Yang's avatar
Michael Yang committed
24
	"strconv"
Michael Yang's avatar
Michael Yang committed
25
	"strings"
26
	"sync/atomic"
27
	"syscall"
Michael Yang's avatar
Michael Yang committed
28
	"time"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
29

30
	"github.com/containerd/console"
31
	"github.com/mattn/go-runewidth"
Patrick Devine's avatar
Patrick Devine committed
32
	"github.com/olekukonko/tablewriter"
Michael Yang's avatar
Michael Yang committed
33
	"github.com/spf13/cobra"
34
	"golang.org/x/crypto/ssh"
35
	"golang.org/x/term"
Michael Yang's avatar
Michael Yang committed
36

37
	"github.com/ollama/ollama/api"
38
	"github.com/ollama/ollama/auth"
39
	"github.com/ollama/ollama/envconfig"
40
	"github.com/ollama/ollama/format"
41
	"github.com/ollama/ollama/parser"
42
43
	"github.com/ollama/ollama/progress"
	"github.com/ollama/ollama/server"
44
45
	"github.com/ollama/ollama/types/errtypes"
	"github.com/ollama/ollama/types/model"
46
	"github.com/ollama/ollama/version"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
47
48
)

49
50
51
52
53
54
55
56
57
58
59
60
61
62
var (
	errModelNotFound     = errors.New("no Modelfile or safetensors files found")
	errModelfileNotFound = errors.New("specified Modelfile wasn't found")
)

func getModelfileName(cmd *cobra.Command) (string, error) {
	fn, _ := cmd.Flags().GetString("file")

	filename := fn
	if filename == "" {
		filename = "Modelfile"
	}

	absName, err := filepath.Abs(filename)
63
	if err != nil {
64
		return "", err
65
66
	}

67
	_, err = os.Stat(absName)
68
	if err != nil {
69
		return fn, err
70
	}
71

72
73
74
75
	return absName, nil
}

func CreateHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
76
77
78
	p := progress.NewProgress(os.Stderr)
	defer p.Stop()

79
80
81
82
83
84
85
86
87
88
	var reader io.Reader

	filename, err := getModelfileName(cmd)
	if os.IsNotExist(err) {
		if filename == "" {
			reader = strings.NewReader("FROM .\n")
		} else {
			return errModelfileNotFound
		}
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
89
		return err
90
91
92
93
94
95
96
97
	} else {
		f, err := os.Open(filename)
		if err != nil {
			return err
		}

		reader = f
		defer f.Close()
Michael Yang's avatar
Michael Yang committed
98
99
	}

100
	modelfile, err := parser.ParseFile(reader)
Michael Yang's avatar
Michael Yang committed
101
102
103
104
105
106
107
108
109
	if err != nil {
		return err
	}

	home, err := os.UserHomeDir()
	if err != nil {
		return err
	}

110
111
	status := "transferring model data"
	spinner := progress.NewSpinner(status)
112
	p.Add(status, spinner)
113
	defer p.Stop()
114

115
116
117
118
119
	client, err := api.ClientFromEnvironment()
	if err != nil {
		return err
	}

Michael Yang's avatar
Michael Yang committed
120
121
	for i := range modelfile.Commands {
		switch modelfile.Commands[i].Name {
Michael Yang's avatar
Michael Yang committed
122
		case "model", "adapter":
Michael Yang's avatar
Michael Yang committed
123
			path := modelfile.Commands[i].Args
Michael Yang's avatar
Michael Yang committed
124
125
126
127
128
129
			if path == "~" {
				path = home
			} else if strings.HasPrefix(path, "~/") {
				path = filepath.Join(home, path[2:])
			}

130
131
132
133
			if !filepath.IsAbs(path) {
				path = filepath.Join(filepath.Dir(filename), path)
			}

134
			fi, err := os.Stat(path)
Michael Yang's avatar
Michael Yang committed
135
			if errors.Is(err, os.ErrNotExist) && modelfile.Commands[i].Name == "model" {
Michael Yang's avatar
Michael Yang committed
136
				continue
Michael Yang's avatar
Michael Yang committed
137
138
139
140
			} else if err != nil {
				return err
			}

141
			if fi.IsDir() {
Michael Yang's avatar
Michael Yang committed
142
143
144
				// this is likely a safetensors or pytorch directory
				// TODO make this work w/ adapters
				tempfile, err := tempZipFiles(path)
145
146
147
				if err != nil {
					return err
				}
Michael Yang's avatar
Michael Yang committed
148
				defer os.RemoveAll(tempfile)
149

Michael Yang's avatar
Michael Yang committed
150
				path = tempfile
Michael Yang's avatar
Michael Yang committed
151
152
			}

153
			digest, err := createBlob(cmd, client, path, spinner)
154
			if err != nil {
Michael Yang's avatar
Michael Yang committed
155
156
157
				return err
			}

Michael Yang's avatar
Michael Yang committed
158
			modelfile.Commands[i].Args = "@" + digest
Michael Yang's avatar
Michael Yang committed
159
160
		}
	}
Michael Yang's avatar
Michael Yang committed
161

Michael Yang's avatar
Michael Yang committed
162
	bars := make(map[string]*progress.Bar)
163
	fn := func(resp api.ProgressResponse) error {
Michael Yang's avatar
Michael Yang committed
164
165
166
167
168
		if resp.Digest != "" {
			spinner.Stop()

			bar, ok := bars[resp.Digest]
			if !ok {
169
				bar = progress.NewBar(fmt.Sprintf("pulling %s...", resp.Digest[7:19]), resp.Total, resp.Completed)
Michael Yang's avatar
Michael Yang committed
170
171
172
173
174
175
176
177
178
179
180
181
182
				bars[resp.Digest] = bar
				p.Add(resp.Digest, bar)
			}

			bar.Set(resp.Completed)
		} else if status != resp.Status {
			spinner.Stop()

			status = resp.Status
			spinner = progress.NewSpinner(status)
			p.Add(status, spinner)
		}

183
184
185
		return nil
	}

186
	quantize, _ := cmd.Flags().GetString("quantize")
Michael Yang's avatar
Michael Yang committed
187

188
	request := api.CreateRequest{Name: args[0], Modelfile: modelfile.String(), Quantize: quantize}
Michael Yang's avatar
Michael Yang committed
189
	if err := client.Create(cmd.Context(), &request, fn); err != nil {
190
191
192
193
194
195
		return err
	}

	return nil
}

Michael Yang's avatar
Michael Yang committed
196
197
198
199
200
201
202
func tempZipFiles(path string) (string, error) {
	tempfile, err := os.CreateTemp("", "ollama-tf")
	if err != nil {
		return "", err
	}
	defer tempfile.Close()

Michael Yang's avatar
Michael Yang committed
203
204
	detectContentType := func(path string) (string, error) {
		f, err := os.Open(path)
Michael Yang's avatar
Michael Yang committed
205
206
207
		if err != nil {
			return "", err
		}
Michael Yang's avatar
Michael Yang committed
208
		defer f.Close()
Michael Yang's avatar
Michael Yang committed
209

Michael Yang's avatar
Michael Yang committed
210
211
		var b bytes.Buffer
		b.Grow(512)
Michael Yang's avatar
Michael Yang committed
212

Michael Yang's avatar
Michael Yang committed
213
214
215
216
217
218
		if _, err := io.CopyN(&b, f, 512); err != nil && !errors.Is(err, io.EOF) {
			return "", err
		}

		contentType, _, _ := strings.Cut(http.DetectContentType(b.Bytes()), ";")
		return contentType, nil
Michael Yang's avatar
Michael Yang committed
219
220
	}

Michael Yang's avatar
Michael Yang committed
221
222
223
224
225
226
227
228
229
230
231
	glob := func(pattern, contentType string) ([]string, error) {
		matches, err := filepath.Glob(pattern)
		if err != nil {
			return nil, err
		}

		for _, safetensor := range matches {
			if ct, err := detectContentType(safetensor); err != nil {
				return nil, err
			} else if ct != contentType {
				return nil, fmt.Errorf("invalid content type: expected %s for %s", ct, safetensor)
Michael Yang's avatar
Michael Yang committed
232
			}
Michael Yang's avatar
Michael Yang committed
233
234
235
236
237
238
239
240
241
242
		}

		return matches, nil
	}

	var files []string
	if st, _ := glob(filepath.Join(path, "model*.safetensors"), "application/octet-stream"); len(st) > 0 {
		// safetensors files might be unresolved git lfs references; skip if they are
		// covers model-x-of-y.safetensors, model.fp32-x-of-y.safetensors, model.safetensors
		files = append(files, st...)
243
244
245
246
247
248
	} else if st, _ := glob(filepath.Join(path, "adapters.safetensors"), "application/octet-stream"); len(st) > 0 {
		// covers adapters.safetensors
		files = append(files, st...)
	} else if st, _ := glob(filepath.Join(path, "adapter_model.safetensors"), "application/octet-stream"); len(st) > 0 {
		// covers adapter_model.safetensors
		files = append(files, st...)
Michael Yang's avatar
Michael Yang committed
249
250
251
252
	} else if pt, _ := glob(filepath.Join(path, "pytorch_model*.bin"), "application/zip"); len(pt) > 0 {
		// pytorch files might also be unresolved git lfs references; skip if they are
		// covers pytorch_model-x-of-y.bin, pytorch_model.fp32-x-of-y.bin, pytorch_model.bin
		files = append(files, pt...)
Patrick Devine's avatar
Patrick Devine committed
253
	} else if pt, _ := glob(filepath.Join(path, "consolidated*.pth"), "application/zip"); len(pt) > 0 {
Michael Yang's avatar
Michael Yang committed
254
255
256
257
		// pytorch files might also be unresolved git lfs references; skip if they are
		// covers consolidated.x.pth, consolidated.pth
		files = append(files, pt...)
	} else {
258
		return "", errModelNotFound
Michael Yang's avatar
Michael Yang committed
259
260
261
262
263
264
265
266
267
	}

	// add configuration files, json files are detected as text/plain
	js, err := glob(filepath.Join(path, "*.json"), "text/plain")
	if err != nil {
		return "", err
	}
	files = append(files, js...)

Michael Yang's avatar
Michael Yang committed
268
269
270
271
272
273
274
275
	// bert models require a nested config.json
	// TODO(mxyng): merge this with the glob above
	js, err = glob(filepath.Join(path, "**/*.json"), "text/plain")
	if err != nil {
		return "", err
	}
	files = append(files, js...)

Michael Yang's avatar
Michael Yang committed
276
277
278
279
280
281
282
283
284
	if tks, _ := glob(filepath.Join(path, "tokenizer.model"), "application/octet-stream"); len(tks) > 0 {
		// add tokenizer.model if it exists, tokenizer.json is automatically picked up by the previous glob
		// tokenizer.model might be a unresolved git lfs reference; error if it is
		files = append(files, tks...)
	} else if tks, _ := glob(filepath.Join(path, "**/tokenizer.model"), "text/plain"); len(tks) > 0 {
		// some times tokenizer.model is in a subdirectory (e.g. meta-llama/Meta-Llama-3-8B)
		files = append(files, tks...)
	}

285
286
287
	zipfile := zip.NewWriter(tempfile)
	defer zipfile.Close()

Michael Yang's avatar
Michael Yang committed
288
289
290
	for _, file := range files {
		f, err := os.Open(file)
		if err != nil {
Michael Yang's avatar
Michael Yang committed
291
292
			return "", err
		}
Michael Yang's avatar
Michael Yang committed
293
		defer f.Close()
Michael Yang's avatar
Michael Yang committed
294
295
296
297
298
299

		fi, err := f.Stat()
		if err != nil {
			return "", err
		}

Michael Yang's avatar
Michael Yang committed
300
		zfi, err := zip.FileInfoHeader(fi)
Michael Yang's avatar
Michael Yang committed
301
302
303
304
		if err != nil {
			return "", err
		}

Michael Yang's avatar
Michael Yang committed
305
306
307
308
309
		zfi.Name, err = filepath.Rel(path, file)
		if err != nil {
			return "", err
		}

Michael Yang's avatar
Michael Yang committed
310
		zf, err := zipfile.CreateHeader(zfi)
Michael Yang's avatar
Michael Yang committed
311
312
313
314
		if err != nil {
			return "", err
		}

Michael Yang's avatar
Michael Yang committed
315
		if _, err := io.Copy(zf, f); err != nil {
Michael Yang's avatar
Michael Yang committed
316
317
318
319
320
321
322
			return "", err
		}
	}

	return tempfile.Name(), nil
}

323
func createBlob(cmd *cobra.Command, client *api.Client, path string, spinner *progress.Spinner) (string, error) {
324
325
326
327
328
329
	bin, err := os.Open(path)
	if err != nil {
		return "", err
	}
	defer bin.Close()

330
331
332
333
334
335
336
	// Get file info to retrieve the size
	fileInfo, err := bin.Stat()
	if err != nil {
		return "", err
	}
	fileSize := fileInfo.Size()

337
338
339
340
	hash := sha256.New()
	if _, err := io.Copy(hash, bin); err != nil {
		return "", err
	}
341
342
343
344

	if _, err := bin.Seek(0, io.SeekStart); err != nil {
		return "", err
	}
345

346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
	var pw progressWriter
	status := "transferring model data 0%"
	spinner.SetMessage(status)

	done := make(chan struct{})
	defer close(done)

	go func() {
		ticker := time.NewTicker(60 * time.Millisecond)
		defer ticker.Stop()
		for {
			select {
			case <-ticker.C:
				spinner.SetMessage(fmt.Sprintf("transferring model data %d%%", int(100*pw.n.Load()/fileSize)))
			case <-done:
				spinner.SetMessage("transferring model data 100%")
				return
			}
		}
	}()

367
	digest := fmt.Sprintf("sha256:%x", hash.Sum(nil))
368
	if err = client.CreateBlob(cmd.Context(), digest, io.TeeReader(bin, &pw)); err != nil {
369
370
371
372
373
		return "", err
	}
	return digest, nil
}

374
375
376
377
378
379
380
381
382
type progressWriter struct {
	n atomic.Int64
}

func (w *progressWriter) Write(p []byte) (n int, err error) {
	w.n.Add(int64(len(p)))
	return len(p), nil
}

Patrick Devine's avatar
Patrick Devine committed
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
func loadOrUnloadModel(cmd *cobra.Command, opts *runOptions) error {
	p := progress.NewProgress(os.Stderr)
	defer p.StopAndClear()

	spinner := progress.NewSpinner("")
	p.Add("", spinner)

	client, err := api.ClientFromEnvironment()
	if err != nil {
		return err
	}

	req := &api.GenerateRequest{
		Model:     opts.Model,
		KeepAlive: opts.KeepAlive,
	}

	return client.Generate(cmd.Context(), req, func(api.GenerateResponse) error { return nil })
}

func StopHandler(cmd *cobra.Command, args []string) error {
	opts := &runOptions{
		Model:     args[0],
		KeepAlive: &api.Duration{Duration: 0},
	}
	if err := loadOrUnloadModel(cmd, opts); err != nil {
		if strings.Contains(err.Error(), "not found") {
			return fmt.Errorf("couldn't find model \"%s\" to stop", args[0])
		}
	}
	return nil
}

416
func RunHandler(cmd *cobra.Command, args []string) error {
417
418
419
	interactive := true

	opts := runOptions{
420
421
422
		Model:    args[0],
		WordWrap: os.Getenv("TERM") == "xterm-256color",
		Options:  map[string]interface{}{},
423
424
425
426
427
428
429
430
	}

	format, err := cmd.Flags().GetString("format")
	if err != nil {
		return err
	}
	opts.Format = format

431
432
433
434
435
436
437
438
439
440
441
442
	keepAlive, err := cmd.Flags().GetString("keepalive")
	if err != nil {
		return err
	}
	if keepAlive != "" {
		d, err := time.ParseDuration(keepAlive)
		if err != nil {
			return err
		}
		opts.KeepAlive = &api.Duration{Duration: d}
	}

443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
	prompts := args[1:]
	// prepend stdin to the prompt if provided
	if !term.IsTerminal(int(os.Stdin.Fd())) {
		in, err := io.ReadAll(os.Stdin)
		if err != nil {
			return err
		}

		prompts = append([]string{string(in)}, prompts...)
		opts.WordWrap = false
		interactive = false
	}
	opts.Prompt = strings.Join(prompts, " ")
	if len(prompts) > 0 {
		interactive = false
	}
459
460
461
462
	// Be quiet if we're redirecting to a pipe or file
	if !term.IsTerminal(int(os.Stdout.Fd())) {
		interactive = false
	}
463
464
465
466
467
468
469

	nowrap, err := cmd.Flags().GetBool("nowordwrap")
	if err != nil {
		return err
	}
	opts.WordWrap = !nowrap

470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
	// Fill out the rest of the options based on information about the
	// model.
	client, err := api.ClientFromEnvironment()
	if err != nil {
		return err
	}

	name := args[0]
	info, err := func() (*api.ShowResponse, error) {
		showReq := &api.ShowRequest{Name: name}
		info, err := client.Show(cmd.Context(), showReq)
		var se api.StatusError
		if errors.As(err, &se) && se.StatusCode == http.StatusNotFound {
			if err := PullHandler(cmd, []string{name}); err != nil {
				return nil, err
			}
			return client.Show(cmd.Context(), &api.ShowRequest{Name: name})
		}
		return info, err
	}()
	if err != nil {
		return err
492
493
	}

494
	opts.MultiModal = len(info.ProjectorInfo) != 0
495
496
497
	opts.ParentModel = info.Details.ParentModel

	if interactive {
Patrick Devine's avatar
Patrick Devine committed
498
		if err := loadOrUnloadModel(cmd, &opts); err != nil {
Michael Yang's avatar
Michael Yang committed
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
			return err
		}

		for _, msg := range info.Messages {
			switch msg.Role {
			case "user":
				fmt.Printf(">>> %s\n", msg.Content)
			case "assistant":
				state := &displayResponseState{}
				displayResponse(msg.Content, opts.WordWrap, state)
				fmt.Println()
				fmt.Println()
			}
		}

514
515
516
		return generateInteractive(cmd, opts)
	}
	return generate(cmd, opts)
Bruce MacDonald's avatar
Bruce MacDonald committed
517
518
}

519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
func errFromUnknownKey(unknownKeyErr error) error {
	// find SSH public key in the error message
	sshKeyPattern := `ssh-\w+ [^\s"]+`
	re := regexp.MustCompile(sshKeyPattern)
	matches := re.FindStringSubmatch(unknownKeyErr.Error())

	if len(matches) > 0 {
		serverPubKey := matches[0]

		localPubKey, err := auth.GetPublicKey()
		if err != nil {
			return unknownKeyErr
		}

		if runtime.GOOS == "linux" && serverPubKey != localPubKey {
			// try the ollama service public key
			svcPubKey, err := os.ReadFile("/usr/share/ollama/.ollama/id_ed25519.pub")
			if err != nil {
				return unknownKeyErr
			}
			localPubKey = strings.TrimSpace(string(svcPubKey))
		}

		// check if the returned public key matches the local public key, this prevents adding a remote key to the user's account
		if serverPubKey != localPubKey {
			return unknownKeyErr
		}

		var msg strings.Builder
		msg.WriteString(unknownKeyErr.Error())
		msg.WriteString("\n\nYour ollama key is:\n")
		msg.WriteString(localPubKey)
		msg.WriteString("\nAdd your key at:\n")
		msg.WriteString("https://ollama.com/settings/keys")

		return errors.New(msg.String())
	}

	return unknownKeyErr
}

560
func PushHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
561
	client, err := api.ClientFromEnvironment()
562
563
564
	if err != nil {
		return err
	}
565

566
567
568
569
570
	insecure, err := cmd.Flags().GetBool("insecure")
	if err != nil {
		return err
	}

Michael Yang's avatar
Michael Yang committed
571
572
573
574
	p := progress.NewProgress(os.Stderr)
	defer p.Stop()

	bars := make(map[string]*progress.Bar)
575
576
	var status string
	var spinner *progress.Spinner
Michael Yang's avatar
Michael Yang committed
577

578
	fn := func(resp api.ProgressResponse) error {
Michael Yang's avatar
Michael Yang committed
579
		if resp.Digest != "" {
580
581
582
			if spinner != nil {
				spinner.Stop()
			}
Michael Yang's avatar
Michael Yang committed
583
584
585

			bar, ok := bars[resp.Digest]
			if !ok {
586
				bar = progress.NewBar(fmt.Sprintf("pushing %s...", resp.Digest[7:19]), resp.Total, resp.Completed)
Michael Yang's avatar
Michael Yang committed
587
588
589
590
591
592
				bars[resp.Digest] = bar
				p.Add(resp.Digest, bar)
			}

			bar.Set(resp.Completed)
		} else if status != resp.Status {
593
594
595
			if spinner != nil {
				spinner.Stop()
			}
Michael Yang's avatar
Michael Yang committed
596
597
598
599
600
601

			status = resp.Status
			spinner = progress.NewSpinner(status)
			p.Add(status, spinner)
		}

602
603
604
		return nil
	}

Michael Yang's avatar
Michael Yang committed
605
	request := api.PushRequest{Name: args[0], Insecure: insecure}
Michael Yang's avatar
Michael Yang committed
606
	if err := client.Push(cmd.Context(), &request, fn); err != nil {
607
608
609
610
611
612
613
614
615
616
617
618
619
620
		if spinner != nil {
			spinner.Stop()
		}
		if strings.Contains(err.Error(), "access denied") {
			return errors.New("you are not authorized to push to this namespace, create the model under a namespace you own")
		}
		host := model.ParseName(args[0]).Host
		isOllamaHost := strings.HasSuffix(host, ".ollama.ai") || strings.HasSuffix(host, ".ollama.com")
		if strings.Contains(err.Error(), errtypes.UnknownOllamaKeyErrMsg) && isOllamaHost {
			// the user has not added their ollama key to ollama.com
			// re-throw an error with a more user-friendly message
			return errFromUnknownKey(err)
		}

Michael Yang's avatar
Michael Yang committed
621
622
623
		return err
	}

624
	spinner.Stop()
Michael Yang's avatar
Michael Yang committed
625
	return nil
626
627
}

628
func ListHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
629
	client, err := api.ClientFromEnvironment()
630
631
632
	if err != nil {
		return err
	}
Patrick Devine's avatar
Patrick Devine committed
633

Michael Yang's avatar
Michael Yang committed
634
	models, err := client.List(cmd.Context())
Patrick Devine's avatar
Patrick Devine committed
635
636
637
638
639
640
641
	if err != nil {
		return err
	}

	var data [][]string

	for _, m := range models.Models {
Michael Yang's avatar
Michael Yang committed
642
		if len(args) == 0 || strings.HasPrefix(m.Name, args[0]) {
643
			data = append(data, []string{m.Name, m.Digest[:12], format.HumanBytes(m.Size), format.HumanTime(m.ModifiedAt, "Never")})
Michael Yang's avatar
Michael Yang committed
644
		}
Patrick Devine's avatar
Patrick Devine committed
645
646
647
	}

	table := tablewriter.NewWriter(os.Stdout)
Patrick Devine's avatar
Patrick Devine committed
648
	table.SetHeader([]string{"NAME", "ID", "SIZE", "MODIFIED"})
Patrick Devine's avatar
Patrick Devine committed
649
650
651
652
653
	table.SetHeaderAlignment(tablewriter.ALIGN_LEFT)
	table.SetAlignment(tablewriter.ALIGN_LEFT)
	table.SetHeaderLine(false)
	table.SetBorder(false)
	table.SetNoWhiteSpace(true)
Michael Yang's avatar
Michael Yang committed
654
	table.SetTablePadding("    ")
Patrick Devine's avatar
Patrick Devine committed
655
656
657
658
659
660
	table.AppendBulk(data)
	table.Render()

	return nil
}

661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
func ListRunningHandler(cmd *cobra.Command, args []string) error {
	client, err := api.ClientFromEnvironment()
	if err != nil {
		return err
	}

	models, err := client.ListRunning(cmd.Context())
	if err != nil {
		return err
	}

	var data [][]string

	for _, m := range models.Models {
		if len(args) == 0 || strings.HasPrefix(m.Name, args[0]) {
			var procStr string
			switch {
			case m.SizeVRAM == 0:
				procStr = "100% CPU"
			case m.SizeVRAM == m.Size:
				procStr = "100% GPU"
			case m.SizeVRAM > m.Size || m.Size == 0:
				procStr = "Unknown"
			default:
				sizeCPU := m.Size - m.SizeVRAM
				cpuPercent := math.Round(float64(sizeCPU) / float64(m.Size) * 100)
				procStr = fmt.Sprintf("%d%%/%d%% CPU/GPU", int(cpuPercent), int(100-cpuPercent))
			}
Patrick Devine's avatar
Patrick Devine committed
689
690
691
692
693
694
695
696
697

			var until string
			delta := time.Since(m.ExpiresAt)
			if delta > 0 {
				until = "Stopping..."
			} else {
				until = format.HumanTime(m.ExpiresAt, "Never")
			}
			data = append(data, []string{m.Name, m.Digest[:12], format.HumanBytes(m.Size), procStr, until})
698
699
700
701
702
703
704
705
706
707
		}
	}

	table := tablewriter.NewWriter(os.Stdout)
	table.SetHeader([]string{"NAME", "ID", "SIZE", "PROCESSOR", "UNTIL"})
	table.SetHeaderAlignment(tablewriter.ALIGN_LEFT)
	table.SetAlignment(tablewriter.ALIGN_LEFT)
	table.SetHeaderLine(false)
	table.SetBorder(false)
	table.SetNoWhiteSpace(true)
Michael Yang's avatar
Michael Yang committed
708
	table.SetTablePadding("    ")
709
710
711
712
713
714
	table.AppendBulk(data)
	table.Render()

	return nil
}

715
func DeleteHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
716
	client, err := api.ClientFromEnvironment()
717
718
719
	if err != nil {
		return err
	}
720

721
722
723
724
725
726
727
728
729
730
731
	// Unload the model if it's running before deletion
	opts := &runOptions{
		Model:     args[0],
		KeepAlive: &api.Duration{Duration: 0},
	}
	if err := loadOrUnloadModel(cmd, opts); err != nil {
		if !strings.Contains(err.Error(), "not found") {
			return fmt.Errorf("unable to stop existing running model \"%s\": %s", args[0], err)
		}
	}

732
733
	for _, name := range args {
		req := api.DeleteRequest{Name: name}
Michael Yang's avatar
Michael Yang committed
734
		if err := client.Delete(cmd.Context(), &req); err != nil {
735
736
737
			return err
		}
		fmt.Printf("deleted '%s'\n", name)
738
739
740
741
	}
	return nil
}

Patrick Devine's avatar
Patrick Devine committed
742
func ShowHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
743
	client, err := api.ClientFromEnvironment()
Patrick Devine's avatar
Patrick Devine committed
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
	if err != nil {
		return err
	}

	license, errLicense := cmd.Flags().GetBool("license")
	modelfile, errModelfile := cmd.Flags().GetBool("modelfile")
	parameters, errParams := cmd.Flags().GetBool("parameters")
	system, errSystem := cmd.Flags().GetBool("system")
	template, errTemplate := cmd.Flags().GetBool("template")

	for _, boolErr := range []error{errLicense, errModelfile, errParams, errSystem, errTemplate} {
		if boolErr != nil {
			return errors.New("error retrieving flags")
		}
	}

	flagsSet := 0
	showType := ""

	if license {
		flagsSet++
		showType = "license"
	}

	if modelfile {
		flagsSet++
		showType = "modelfile"
	}

	if parameters {
		flagsSet++
		showType = "parameters"
	}

	if system {
		flagsSet++
		showType = "system"
	}

	if template {
		flagsSet++
		showType = "template"
	}

	if flagsSet > 1 {
789
		return errors.New("only one of '--license', '--modelfile', '--parameters', '--system', or '--template' can be specified")
790
791
	}

792
793
794
795
796
	req := api.ShowRequest{Name: args[0]}
	resp, err := client.Show(cmd.Context(), &req)
	if err != nil {
		return err
	}
797

798
	if flagsSet == 1 {
799
800
801
802
803
804
805
806
		switch showType {
		case "license":
			fmt.Println(resp.License)
		case "modelfile":
			fmt.Println(resp.Modelfile)
		case "parameters":
			fmt.Println(resp.Parameters)
		case "system":
807
			fmt.Print(resp.System)
808
		case "template":
809
			fmt.Print(resp.Template)
810
811
812
		}

		return nil
Patrick Devine's avatar
Patrick Devine committed
813
814
	}

Michael Yang's avatar
Michael Yang committed
815
	return showInfo(resp, os.Stdout)
816
817
}

Michael Yang's avatar
Michael Yang committed
818
819
820
821
822
823
824
825
func showInfo(resp *api.ShowResponse, w io.Writer) error {
	tableRender := func(header string, rows func() [][]string) {
		fmt.Fprintln(w, " ", header)
		table := tablewriter.NewWriter(w)
		table.SetAlignment(tablewriter.ALIGN_LEFT)
		table.SetBorder(false)
		table.SetNoWhiteSpace(true)
		table.SetTablePadding("    ")
826

Michael Yang's avatar
Michael Yang committed
827
828
829
		switch header {
		case "Template", "System", "License":
			table.SetColWidth(100)
830
831
		}

Michael Yang's avatar
Michael Yang committed
832
833
834
		table.AppendBulk(rows())
		table.Render()
		fmt.Fprintln(w)
Patrick Devine's avatar
Patrick Devine committed
835
836
	}

Michael Yang's avatar
Michael Yang committed
837
838
839
840
841
842
843
844
845
846
847
848
849
850
	tableRender("Model", func() (rows [][]string) {
		if resp.ModelInfo != nil {
			arch := resp.ModelInfo["general.architecture"].(string)
			rows = append(rows, []string{"", "architecture", arch})
			rows = append(rows, []string{"", "parameters", format.HumanNumber(uint64(resp.ModelInfo["general.parameter_count"].(float64)))})
			rows = append(rows, []string{"", "context length", strconv.FormatFloat(resp.ModelInfo[fmt.Sprintf("%s.context_length", arch)].(float64), 'f', -1, 64)})
			rows = append(rows, []string{"", "embedding length", strconv.FormatFloat(resp.ModelInfo[fmt.Sprintf("%s.embedding_length", arch)].(float64), 'f', -1, 64)})
		} else {
			rows = append(rows, []string{"", "architecture", resp.Details.Family})
			rows = append(rows, []string{"", "parameters", resp.Details.ParameterSize})
		}
		rows = append(rows, []string{"", "quantization", resp.Details.QuantizationLevel})
		return
	})
851

Michael Yang's avatar
Michael Yang committed
852
853
854
855
856
857
858
859
860
	if resp.ProjectorInfo != nil {
		tableRender("Projector", func() (rows [][]string) {
			arch := resp.ProjectorInfo["general.architecture"].(string)
			rows = append(rows, []string{"", "architecture", arch})
			rows = append(rows, []string{"", "parameters", format.HumanNumber(uint64(resp.ProjectorInfo["general.parameter_count"].(float64)))})
			rows = append(rows, []string{"", "embedding length", strconv.FormatFloat(resp.ProjectorInfo[fmt.Sprintf("%s.vision.embedding_length", arch)].(float64), 'f', -1, 64)})
			rows = append(rows, []string{"", "dimensions", strconv.FormatFloat(resp.ProjectorInfo[fmt.Sprintf("%s.vision.projection_dim", arch)].(float64), 'f', -1, 64)})
			return
		})
861
862
	}

Michael Yang's avatar
Michael Yang committed
863
864
865
866
867
868
869
870
871
872
	if resp.Parameters != "" {
		tableRender("Parameters", func() (rows [][]string) {
			scanner := bufio.NewScanner(strings.NewReader(resp.Parameters))
			for scanner.Scan() {
				if text := scanner.Text(); text != "" {
					rows = append(rows, append([]string{""}, strings.Fields(text)...))
				}
			}
			return
		})
873
874
	}

Michael Yang's avatar
Michael Yang committed
875
876
877
878
879
	head := func(s string, n int) (rows [][]string) {
		scanner := bufio.NewScanner(strings.NewReader(s))
		for scanner.Scan() && (len(rows) < n || n < 0) {
			if text := scanner.Text(); text != "" {
				rows = append(rows, []string{"", strings.TrimSpace(text)})
880
881
			}
		}
Michael Yang's avatar
Michael Yang committed
882
		return
883
884
	}

Michael Yang's avatar
Michael Yang committed
885
886
887
888
889
	if resp.System != "" {
		tableRender("System", func() [][]string {
			return head(resp.System, 2)
		})
	}
890

Michael Yang's avatar
Michael Yang committed
891
892
893
894
	if resp.License != "" {
		tableRender("License", func() [][]string {
			return head(resp.License, 2)
		})
895
	}
Michael Yang's avatar
Michael Yang committed
896
897

	return nil
898
899
}

Patrick Devine's avatar
Patrick Devine committed
900
func CopyHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
901
	client, err := api.ClientFromEnvironment()
902
903
904
	if err != nil {
		return err
	}
Patrick Devine's avatar
Patrick Devine committed
905
906

	req := api.CopyRequest{Source: args[0], Destination: args[1]}
Michael Yang's avatar
Michael Yang committed
907
	if err := client.Copy(cmd.Context(), &req); err != nil {
Patrick Devine's avatar
Patrick Devine committed
908
909
910
911
912
913
		return err
	}
	fmt.Printf("copied '%s' to '%s'\n", args[0], args[1])
	return nil
}

914
func PullHandler(cmd *cobra.Command, args []string) error {
915
916
917
918
919
	insecure, err := cmd.Flags().GetBool("insecure")
	if err != nil {
		return err
	}

Michael Yang's avatar
Michael Yang committed
920
	client, err := api.ClientFromEnvironment()
921
922
923
	if err != nil {
		return err
	}
924

Michael Yang's avatar
Michael Yang committed
925
926
927
928
929
	p := progress.NewProgress(os.Stderr)
	defer p.Stop()

	bars := make(map[string]*progress.Bar)

930
931
	var status string
	var spinner *progress.Spinner
Michael Yang's avatar
Michael Yang committed
932

933
	fn := func(resp api.ProgressResponse) error {
Michael Yang's avatar
Michael Yang committed
934
		if resp.Digest != "" {
935
936
937
			if spinner != nil {
				spinner.Stop()
			}
Michael Yang's avatar
Michael Yang committed
938
939
940

			bar, ok := bars[resp.Digest]
			if !ok {
941
				bar = progress.NewBar(fmt.Sprintf("pulling %s...", resp.Digest[7:19]), resp.Total, resp.Completed)
Michael Yang's avatar
Michael Yang committed
942
943
944
945
946
947
				bars[resp.Digest] = bar
				p.Add(resp.Digest, bar)
			}

			bar.Set(resp.Completed)
		} else if status != resp.Status {
948
949
950
			if spinner != nil {
				spinner.Stop()
			}
Michael Yang's avatar
Michael Yang committed
951
952
953
954
955
956

			status = resp.Status
			spinner = progress.NewSpinner(status)
			p.Add(status, spinner)
		}

957
958
		return nil
	}
959

Michael Yang's avatar
Michael Yang committed
960
	request := api.PullRequest{Name: args[0], Insecure: insecure}
Michael Yang's avatar
Michael Yang committed
961
	if err := client.Pull(cmd.Context(), &request, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
962
963
964
965
		return err
	}

	return nil
Michael Yang's avatar
Michael Yang committed
966
967
}

968
969
type generateContextKey string

970
type runOptions struct {
971
972
973
974
975
976
977
978
979
980
	Model       string
	ParentModel string
	Prompt      string
	Messages    []api.Message
	WordWrap    bool
	Format      string
	System      string
	Images      []api.ImageData
	Options     map[string]interface{}
	MultiModal  bool
981
	KeepAlive   *api.Duration
982
983
}

984
985
986
987
988
989
990
991
992
type displayResponseState struct {
	lineLength int
	wordBuffer string
}

func displayResponse(content string, wordWrap bool, state *displayResponseState) {
	termWidth, _, _ := term.GetSize(int(os.Stdout.Fd()))
	if wordWrap && termWidth >= 10 {
		for _, ch := range content {
Josh Yan's avatar
Josh Yan committed
993
994
			if state.lineLength+1 > termWidth-5 {
				if runewidth.StringWidth(state.wordBuffer) > termWidth-10 {
995
996
997
998
999
1000
1001
					fmt.Printf("%s%c", state.wordBuffer, ch)
					state.wordBuffer = ""
					state.lineLength = 0
					continue
				}

				// backtrack the length of the last word and clear to the end of the line
1002
1003
				a := runewidth.StringWidth(state.wordBuffer)
				if a > 0 {
1004
					fmt.Printf("\x1b[%dD", a)
1005
1006
				}
				fmt.Printf("\x1b[K\n")
1007
				fmt.Printf("%s%c", state.wordBuffer, ch)
1008
1009
1010
				chWidth := runewidth.RuneWidth(ch)

				state.lineLength = runewidth.StringWidth(state.wordBuffer) + chWidth
1011
1012
			} else {
				fmt.Print(string(ch))
1013
1014
1015
1016
				state.lineLength += runewidth.RuneWidth(ch)
				if runewidth.RuneWidth(ch) >= 2 {
					state.wordBuffer = ""
					continue
Josh Yan's avatar
Josh Yan committed
1017
				}
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085

				switch ch {
				case ' ':
					state.wordBuffer = ""
				case '\n':
					state.lineLength = 0
				default:
					state.wordBuffer += string(ch)
				}
			}
		}
	} else {
		fmt.Printf("%s%s", state.wordBuffer, content)
		if len(state.wordBuffer) > 0 {
			state.wordBuffer = ""
		}
	}
}

func chat(cmd *cobra.Command, opts runOptions) (*api.Message, error) {
	client, err := api.ClientFromEnvironment()
	if err != nil {
		return nil, err
	}

	p := progress.NewProgress(os.Stderr)
	defer p.StopAndClear()

	spinner := progress.NewSpinner("")
	p.Add("", spinner)

	cancelCtx, cancel := context.WithCancel(cmd.Context())
	defer cancel()

	sigChan := make(chan os.Signal, 1)
	signal.Notify(sigChan, syscall.SIGINT)

	go func() {
		<-sigChan
		cancel()
	}()

	var state *displayResponseState = &displayResponseState{}
	var latest api.ChatResponse
	var fullResponse strings.Builder
	var role string

	fn := func(response api.ChatResponse) error {
		p.StopAndClear()

		latest = response

		role = response.Message.Role
		content := response.Message.Content
		fullResponse.WriteString(content)

		displayResponse(content, opts.WordWrap, state)

		return nil
	}

	req := &api.ChatRequest{
		Model:    opts.Model,
		Messages: opts.Messages,
		Format:   opts.Format,
		Options:  opts.Options,
	}

1086
1087
1088
1089
	if opts.KeepAlive != nil {
		req.KeepAlive = opts.KeepAlive
	}

1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
	if err := client.Chat(cancelCtx, req, fn); err != nil {
		if errors.Is(err, context.Canceled) {
			return nil, nil
		}
		return nil, err
	}

	if len(opts.Messages) > 0 {
		fmt.Println()
		fmt.Println()
	}

	verbose, err := cmd.Flags().GetBool("verbose")
	if err != nil {
		return nil, err
	}

	if verbose {
		latest.Summary()
	}

	return &api.Message{Role: role, Content: fullResponse.String()}, nil
}

func generate(cmd *cobra.Command, opts runOptions) error {
Michael Yang's avatar
Michael Yang committed
1115
	client, err := api.ClientFromEnvironment()
Patrick Devine's avatar
Patrick Devine committed
1116
	if err != nil {
1117
		return err
Patrick Devine's avatar
Patrick Devine committed
1118
	}
Michael Yang's avatar
Michael Yang committed
1119

Michael Yang's avatar
Michael Yang committed
1120
	p := progress.NewProgress(os.Stderr)
1121
	defer p.StopAndClear()
1122

Michael Yang's avatar
Michael Yang committed
1123
1124
1125
	spinner := progress.NewSpinner("")
	p.Add("", spinner)

1126
1127
1128
1129
1130
1131
1132
	var latest api.GenerateResponse

	generateContext, ok := cmd.Context().Value(generateContextKey("context")).([]int)
	if !ok {
		generateContext = []int{}
	}

Michael Yang's avatar
Michael Yang committed
1133
	ctx, cancel := context.WithCancel(cmd.Context())
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
	defer cancel()

	sigChan := make(chan os.Signal, 1)
	signal.Notify(sigChan, syscall.SIGINT)

	go func() {
		<-sigChan
		cancel()
	}()

1144
	var state *displayResponseState = &displayResponseState{}
1145

1146
	fn := func(response api.GenerateResponse) error {
Michael Yang's avatar
Michael Yang committed
1147
		p.StopAndClear()
1148

Patrick Devine's avatar
Patrick Devine committed
1149
		latest = response
1150
		content := response.Response
1151

1152
		displayResponse(content, opts.WordWrap, state)
1153

Patrick Devine's avatar
Patrick Devine committed
1154
1155
		return nil
	}
1156

1157
1158
1159
1160
1161
1162
1163
	if opts.MultiModal {
		opts.Prompt, opts.Images, err = extractFileData(opts.Prompt)
		if err != nil {
			return err
		}
	}

Michael Yang's avatar
Michael Yang committed
1164
	request := api.GenerateRequest{
1165
1166
1167
1168
1169
1170
1171
1172
		Model:     opts.Model,
		Prompt:    opts.Prompt,
		Context:   generateContext,
		Images:    opts.Images,
		Format:    opts.Format,
		System:    opts.System,
		Options:   opts.Options,
		KeepAlive: opts.KeepAlive,
Michael Yang's avatar
Michael Yang committed
1173
1174
1175
	}

	if err := client.Generate(ctx, &request, fn); err != nil {
1176
		if errors.Is(err, context.Canceled) {
1177
			return nil
1178
		}
1179
		return err
Patrick Devine's avatar
Patrick Devine committed
1180
	}
1181

1182
	if opts.Prompt != "" {
Michael Yang's avatar
Michael Yang committed
1183
1184
		fmt.Println()
		fmt.Println()
Patrick Devine's avatar
Patrick Devine committed
1185
	}
1186

1187
1188
1189
1190
	if !latest.Done {
		return nil
	}

Patrick Devine's avatar
Patrick Devine committed
1191
1192
	verbose, err := cmd.Flags().GetBool("verbose")
	if err != nil {
1193
		return err
Patrick Devine's avatar
Patrick Devine committed
1194
	}
Michael Yang's avatar
Michael Yang committed
1195

Patrick Devine's avatar
Patrick Devine committed
1196
1197
	if verbose {
		latest.Summary()
Michael Yang's avatar
Michael Yang committed
1198
	}
Michael Yang's avatar
Michael Yang committed
1199

Patrick Devine's avatar
Patrick Devine committed
1200
1201
1202
	ctx = context.WithValue(cmd.Context(), generateContextKey("context"), latest.Context)
	cmd.SetContext(ctx)

1203
	return nil
Michael Yang's avatar
Michael Yang committed
1204
1205
}

1206
func RunServer(_ *cobra.Command, _ []string) error {
Michael Yang's avatar
Michael Yang committed
1207
	if err := initializeKeypair(); err != nil {
1208
1209
1210
		return err
	}

Michael Yang's avatar
host  
Michael Yang committed
1211
	ln, err := net.Listen("tcp", envconfig.Host().Host)
1212
1213
1214
	if err != nil {
		return err
	}
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1215

1216
1217
1218
1219
1220
1221
	err = server.Serve(ln)
	if errors.Is(err, http.ErrServerClosed) {
		return nil
	}

	return err
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1222
1223
}

1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
func initializeKeypair() error {
	home, err := os.UserHomeDir()
	if err != nil {
		return err
	}

	privKeyPath := filepath.Join(home, ".ollama", "id_ed25519")
	pubKeyPath := filepath.Join(home, ".ollama", "id_ed25519.pub")

	_, err = os.Stat(privKeyPath)
	if os.IsNotExist(err) {
		fmt.Printf("Couldn't find '%s'. Generating new private key.\n", privKeyPath)
Michael Yang's avatar
Michael Yang committed
1236
		cryptoPublicKey, cryptoPrivateKey, err := ed25519.GenerateKey(rand.Reader)
1237
1238
1239
1240
		if err != nil {
			return err
		}

Michael Yang's avatar
Michael Yang committed
1241
		privateKeyBytes, err := ssh.MarshalPrivateKey(cryptoPrivateKey, "")
1242
1243
1244
1245
		if err != nil {
			return err
		}

Michael Yang's avatar
Michael Yang committed
1246
		if err := os.MkdirAll(filepath.Dir(privKeyPath), 0o755); err != nil {
1247
1248
1249
			return fmt.Errorf("could not create directory %w", err)
		}

Michael Yang's avatar
Michael Yang committed
1250
		if err := os.WriteFile(privKeyPath, pem.EncodeToMemory(privateKeyBytes), 0o600); err != nil {
1251
1252
1253
			return err
		}

Michael Yang's avatar
Michael Yang committed
1254
		sshPublicKey, err := ssh.NewPublicKey(cryptoPublicKey)
1255
1256
1257
1258
		if err != nil {
			return err
		}

Michael Yang's avatar
Michael Yang committed
1259
		publicKeyBytes := ssh.MarshalAuthorizedKey(sshPublicKey)
1260

Michael Yang's avatar
Michael Yang committed
1261
		if err := os.WriteFile(pubKeyPath, publicKeyBytes, 0o644); err != nil {
1262
1263
1264
			return err
		}

Michael Yang's avatar
Michael Yang committed
1265
		fmt.Printf("Your new public key is: \n\n%s\n", publicKeyBytes)
1266
1267
1268
1269
	}
	return nil
}

Michael Yang's avatar
Michael Yang committed
1270
func checkServerHeartbeat(cmd *cobra.Command, _ []string) error {
Michael Yang's avatar
Michael Yang committed
1271
	client, err := api.ClientFromEnvironment()
1272
1273
1274
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
1275
	if err := client.Heartbeat(cmd.Context()); err != nil {
1276
		if !strings.Contains(err.Error(), " refused") {
Bruce MacDonald's avatar
Bruce MacDonald committed
1277
1278
			return err
		}
1279
		if err := startApp(cmd.Context(), client); err != nil {
Michael Yang's avatar
lint  
Michael Yang committed
1280
			return errors.New("could not connect to ollama app, is it running?")
1281
1282
1283
1284
1285
		}
	}
	return nil
}

Michael Yang's avatar
Michael Yang committed
1286
1287
1288
1289
1290
1291
1292
1293
func versionHandler(cmd *cobra.Command, _ []string) {
	client, err := api.ClientFromEnvironment()
	if err != nil {
		return
	}

	serverVersion, err := client.Version(cmd.Context())
	if err != nil {
Michael Yang's avatar
Michael Yang committed
1294
1295
1296
1297
1298
		fmt.Println("Warning: could not connect to a running Ollama instance")
	}

	if serverVersion != "" {
		fmt.Printf("ollama version is %s\n", serverVersion)
Michael Yang's avatar
Michael Yang committed
1299
1300
	}

1301
	if serverVersion != version.Version {
Michael Yang's avatar
Michael Yang committed
1302
		fmt.Printf("Warning: client version is %s\n", version.Version)
1303
	}
Michael Yang's avatar
Michael Yang committed
1304
1305
}

1306
func appendEnvDocs(cmd *cobra.Command, envs []envconfig.EnvVar) {
1307
1308
1309
1310
1311
	if len(envs) == 0 {
		return
	}

	envUsage := `
1312
1313
Environment Variables:
`
1314
	for _, e := range envs {
1315
		envUsage += fmt.Sprintf("      %-24s   %s\n", e.Name, e.Description)
1316
1317
1318
	}

	cmd.SetUsageTemplate(cmd.UsageTemplate() + envUsage)
1319
1320
}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1321
1322
func NewCLI() *cobra.Command {
	log.SetFlags(log.LstdFlags | log.Lshortfile)
Michael Yang's avatar
Michael Yang committed
1323
	cobra.EnableCommandSorting = false
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1324

1325
	if runtime.GOOS == "windows" && term.IsTerminal(int(os.Stdout.Fd())) {
1326
		console.ConsoleFromFile(os.Stdin) //nolint:errcheck
1327
1328
	}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1329
	rootCmd := &cobra.Command{
1330
1331
1332
1333
		Use:           "ollama",
		Short:         "Large language model runner",
		SilenceUsage:  true,
		SilenceErrors: true,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1334
1335
1336
		CompletionOptions: cobra.CompletionOptions{
			DisableDefaultCmd: true,
		},
Michael Yang's avatar
Michael Yang committed
1337
1338
1339
1340
1341
1342
1343
1344
		Run: func(cmd *cobra.Command, args []string) {
			if version, _ := cmd.Flags().GetBool("version"); version {
				versionHandler(cmd, args)
				return
			}

			cmd.Print(cmd.UsageString())
		},
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1345
1346
	}

Michael Yang's avatar
Michael Yang committed
1347
	rootCmd.Flags().BoolP("version", "v", false, "Show version information")
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1348

1349
	createCmd := &cobra.Command{
1350
1351
		Use:     "create MODEL",
		Short:   "Create a model from a Modelfile",
Michael Yang's avatar
Michael Yang committed
1352
		Args:    cobra.ExactArgs(1),
1353
1354
		PreRunE: checkServerHeartbeat,
		RunE:    CreateHandler,
1355
1356
	}

1357
	createCmd.Flags().StringP("file", "f", "", "Name of the Modelfile (default \"Modelfile\"")
1358
	createCmd.Flags().StringP("quantize", "q", "", "Quantize model to this level (e.g. q4_0)")
1359

Patrick Devine's avatar
Patrick Devine committed
1360
1361
1362
	showCmd := &cobra.Command{
		Use:     "show MODEL",
		Short:   "Show information for a model",
Michael Yang's avatar
Michael Yang committed
1363
		Args:    cobra.ExactArgs(1),
Patrick Devine's avatar
Patrick Devine committed
1364
1365
1366
1367
1368
1369
1370
1371
		PreRunE: checkServerHeartbeat,
		RunE:    ShowHandler,
	}

	showCmd.Flags().Bool("license", false, "Show license of a model")
	showCmd.Flags().Bool("modelfile", false, "Show Modelfile of a model")
	showCmd.Flags().Bool("parameters", false, "Show parameters of a model")
	showCmd.Flags().Bool("template", false, "Show template of a model")
1372
	showCmd.Flags().Bool("system", false, "Show system message of a model")
Patrick Devine's avatar
Patrick Devine committed
1373

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1374
	runCmd := &cobra.Command{
1375
1376
1377
1378
1379
		Use:     "run MODEL [PROMPT]",
		Short:   "Run a model",
		Args:    cobra.MinimumNArgs(1),
		PreRunE: checkServerHeartbeat,
		RunE:    RunHandler,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1380
1381
	}

1382
	runCmd.Flags().String("keepalive", "", "Duration to keep a model loaded (e.g. 5m)")
1383
	runCmd.Flags().Bool("verbose", false, "Show timings for response")
1384
	runCmd.Flags().Bool("insecure", false, "Use an insecure registry")
1385
	runCmd.Flags().Bool("nowordwrap", false, "Don't wrap words to the next line automatically")
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1386
	runCmd.Flags().String("format", "", "Response format (e.g. json)")
Patrick Devine's avatar
Patrick Devine committed
1387
1388
1389
1390
1391
1392
1393
1394
1395

	stopCmd := &cobra.Command{
		Use:     "stop MODEL",
		Short:   "Stop a running model",
		Args:    cobra.ExactArgs(1),
		PreRunE: checkServerHeartbeat,
		RunE:    StopHandler,
	}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1396
1397
1398
1399
	serveCmd := &cobra.Command{
		Use:     "serve",
		Aliases: []string{"start"},
		Short:   "Start ollama",
Michael Yang's avatar
Michael Yang committed
1400
		Args:    cobra.ExactArgs(0),
Michael Yang's avatar
Michael Yang committed
1401
		RunE:    RunServer,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1402
1403
	}

1404
	pullCmd := &cobra.Command{
1405
1406
		Use:     "pull MODEL",
		Short:   "Pull a model from a registry",
Michael Yang's avatar
Michael Yang committed
1407
		Args:    cobra.ExactArgs(1),
1408
1409
		PreRunE: checkServerHeartbeat,
		RunE:    PullHandler,
1410
1411
	}

1412
1413
	pullCmd.Flags().Bool("insecure", false, "Use an insecure registry")

1414
	pushCmd := &cobra.Command{
1415
1416
		Use:     "push MODEL",
		Short:   "Push a model to a registry",
Michael Yang's avatar
Michael Yang committed
1417
		Args:    cobra.ExactArgs(1),
1418
1419
		PreRunE: checkServerHeartbeat,
		RunE:    PushHandler,
1420
1421
	}

1422
1423
	pushCmd.Flags().Bool("insecure", false, "Use an insecure registry")

Patrick Devine's avatar
Patrick Devine committed
1424
	listCmd := &cobra.Command{
1425
		Use:     "list",
Patrick Devine's avatar
Patrick Devine committed
1426
		Aliases: []string{"ls"},
1427
		Short:   "List models",
1428
		PreRunE: checkServerHeartbeat,
1429
		RunE:    ListHandler,
1430
	}
1431
1432
1433
1434
1435
1436
1437
1438

	psCmd := &cobra.Command{
		Use:     "ps",
		Short:   "List running models",
		PreRunE: checkServerHeartbeat,
		RunE:    ListRunningHandler,
	}

Patrick Devine's avatar
Patrick Devine committed
1439
	copyCmd := &cobra.Command{
Michael Yang's avatar
Michael Yang committed
1440
		Use:     "cp SOURCE DESTINATION",
1441
		Short:   "Copy a model",
Michael Yang's avatar
Michael Yang committed
1442
		Args:    cobra.ExactArgs(2),
1443
1444
		PreRunE: checkServerHeartbeat,
		RunE:    CopyHandler,
Patrick Devine's avatar
Patrick Devine committed
1445
1446
	}

1447
	deleteCmd := &cobra.Command{
Michael Yang's avatar
Michael Yang committed
1448
		Use:     "rm MODEL [MODEL...]",
1449
1450
1451
1452
		Short:   "Remove a model",
		Args:    cobra.MinimumNArgs(1),
		PreRunE: checkServerHeartbeat,
		RunE:    DeleteHandler,
Patrick Devine's avatar
Patrick Devine committed
1453
1454
	}

1455
1456
1457
	envVars := envconfig.AsMap()

	envs := []envconfig.EnvVar{envVars["OLLAMA_HOST"]}
1458

1459
1460
1461
1462
	for _, cmd := range []*cobra.Command{
		createCmd,
		showCmd,
		runCmd,
Patrick Devine's avatar
Patrick Devine committed
1463
		stopCmd,
1464
1465
1466
		pullCmd,
		pushCmd,
		listCmd,
1467
		psCmd,
1468
1469
		copyCmd,
		deleteCmd,
1470
		serveCmd,
1471
	} {
1472
1473
		switch cmd {
		case runCmd:
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
			appendEnvDocs(cmd, []envconfig.EnvVar{envVars["OLLAMA_HOST"], envVars["OLLAMA_NOHISTORY"]})
		case serveCmd:
			appendEnvDocs(cmd, []envconfig.EnvVar{
				envVars["OLLAMA_DEBUG"],
				envVars["OLLAMA_HOST"],
				envVars["OLLAMA_KEEP_ALIVE"],
				envVars["OLLAMA_MAX_LOADED_MODELS"],
				envVars["OLLAMA_MAX_QUEUE"],
				envVars["OLLAMA_MODELS"],
				envVars["OLLAMA_NUM_PARALLEL"],
				envVars["OLLAMA_NOPRUNE"],
				envVars["OLLAMA_ORIGINS"],
1486
				envVars["OLLAMA_SCHED_SPREAD"],
1487
				envVars["OLLAMA_TMPDIR"],
1488
1489
				envVars["OLLAMA_FLASH_ATTENTION"],
				envVars["OLLAMA_LLM_LIBRARY"],
1490
				envVars["OLLAMA_GPU_OVERHEAD"],
1491
				envVars["OLLAMA_LOAD_TIMEOUT"],
1492
			})
1493
1494
1495
		default:
			appendEnvDocs(cmd, envs)
		}
1496
1497
	}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1498
1499
	rootCmd.AddCommand(
		serveCmd,
1500
		createCmd,
Patrick Devine's avatar
Patrick Devine committed
1501
		showCmd,
1502
		runCmd,
Patrick Devine's avatar
Patrick Devine committed
1503
		stopCmd,
1504
1505
		pullCmd,
		pushCmd,
Patrick Devine's avatar
Patrick Devine committed
1506
		listCmd,
1507
		psCmd,
Patrick Devine's avatar
Patrick Devine committed
1508
		copyCmd,
1509
		deleteCmd,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1510
1511
1512
1513
	)

	return rootCmd
}