cmd.go 26.5 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
	"bytes"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
6
	"context"
7
8
	"crypto/ed25519"
	"crypto/rand"
Michael Yang's avatar
Michael Yang committed
9
	"crypto/sha256"
10
	"encoding/pem"
Michael Yang's avatar
Michael Yang committed
11
	"errors"
Bruce MacDonald's avatar
Bruce MacDonald committed
12
	"fmt"
Michael Yang's avatar
Michael Yang committed
13
	"io"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
14
15
	"log"
	"net"
16
	"net/http"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
17
	"os"
18
	"os/signal"
19
	"path/filepath"
Michael Yang's avatar
Michael Yang committed
20
	"regexp"
21
	"runtime"
Michael Yang's avatar
Michael Yang committed
22
	"strings"
23
	"syscall"
Michael Yang's avatar
Michael Yang committed
24
	"time"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
25

26
27
	"github.com/containerd/console"

Patrick Devine's avatar
Patrick Devine committed
28
	"github.com/olekukonko/tablewriter"
Michael Yang's avatar
Michael Yang committed
29
	"github.com/spf13/cobra"
30
	"golang.org/x/crypto/ssh"
31
	"golang.org/x/exp/slices"
32
	"golang.org/x/term"
Michael Yang's avatar
Michael Yang committed
33

34
	"github.com/ollama/ollama/api"
35
	"github.com/ollama/ollama/auth"
36
37
38
39
	"github.com/ollama/ollama/format"
	"github.com/ollama/ollama/parser"
	"github.com/ollama/ollama/progress"
	"github.com/ollama/ollama/server"
40
41
	"github.com/ollama/ollama/types/errtypes"
	"github.com/ollama/ollama/types/model"
42
	"github.com/ollama/ollama/version"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
43
44
)

45
func CreateHandler(cmd *cobra.Command, args []string) error {
46
	filename, _ := cmd.Flags().GetString("file")
47
48
49
50
51
	filename, err := filepath.Abs(filename)
	if err != nil {
		return err
	}

Michael Yang's avatar
Michael Yang committed
52
	client, err := api.ClientFromEnvironment()
53
54
55
	if err != nil {
		return err
	}
56

Michael Yang's avatar
Michael Yang committed
57
58
59
	p := progress.NewProgress(os.Stderr)
	defer p.Stop()

Michael Yang's avatar
Michael Yang committed
60
	modelfile, err := os.Open(filename)
Michael Yang's avatar
Michael Yang committed
61
62
63
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
64
	defer modelfile.Close()
Michael Yang's avatar
Michael Yang committed
65

Michael Yang's avatar
Michael Yang committed
66
	commands, err := parser.Parse(modelfile)
Michael Yang's avatar
Michael Yang committed
67
68
69
70
71
72
73
74
75
	if err != nil {
		return err
	}

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

76
77
	status := "transferring model data"
	spinner := progress.NewSpinner(status)
78
79
	p.Add(status, spinner)

Michael Yang's avatar
Michael Yang committed
80
81
	for i := range commands {
		switch commands[i].Name {
Michael Yang's avatar
Michael Yang committed
82
		case "model", "adapter":
Michael Yang's avatar
Michael Yang committed
83
			path := commands[i].Args
Michael Yang's avatar
Michael Yang committed
84
85
86
87
88
89
			if path == "~" {
				path = home
			} else if strings.HasPrefix(path, "~/") {
				path = filepath.Join(home, path[2:])
			}

90
91
92
93
			if !filepath.IsAbs(path) {
				path = filepath.Join(filepath.Dir(filename), path)
			}

94
			fi, err := os.Stat(path)
Michael Yang's avatar
Michael Yang committed
95
			if errors.Is(err, os.ErrNotExist) && commands[i].Name == "model" {
Michael Yang's avatar
Michael Yang committed
96
				continue
Michael Yang's avatar
Michael Yang committed
97
98
99
100
			} else if err != nil {
				return err
			}

101
			if fi.IsDir() {
Michael Yang's avatar
Michael Yang committed
102
103
104
				// this is likely a safetensors or pytorch directory
				// TODO make this work w/ adapters
				tempfile, err := tempZipFiles(path)
105
106
107
				if err != nil {
					return err
				}
Michael Yang's avatar
Michael Yang committed
108
				defer os.RemoveAll(tempfile)
109

Michael Yang's avatar
Michael Yang committed
110
				path = tempfile
Michael Yang's avatar
Michael Yang committed
111
112
			}

113
114
			digest, err := createBlob(cmd, client, path)
			if err != nil {
Michael Yang's avatar
Michael Yang committed
115
116
117
				return err
			}

Michael Yang's avatar
Michael Yang committed
118
			commands[i].Args = "@"+digest
Michael Yang's avatar
Michael Yang committed
119
120
		}
	}
Michael Yang's avatar
Michael Yang committed
121

Michael Yang's avatar
Michael Yang committed
122
	bars := make(map[string]*progress.Bar)
123
	fn := func(resp api.ProgressResponse) error {
Michael Yang's avatar
Michael Yang committed
124
125
126
127
128
		if resp.Digest != "" {
			spinner.Stop()

			bar, ok := bars[resp.Digest]
			if !ok {
129
				bar = progress.NewBar(fmt.Sprintf("pulling %s...", resp.Digest[7:19]), resp.Total, resp.Completed)
Michael Yang's avatar
Michael Yang committed
130
131
132
133
134
135
136
137
138
139
140
141
142
				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)
		}

143
144
145
		return nil
	}

Michael Yang's avatar
Michael Yang committed
146
147
	quantization, _ := cmd.Flags().GetString("quantization")

Michael Yang's avatar
Michael Yang committed
148
	request := api.CreateRequest{Name: args[0], Modelfile: parser.Format(commands), Quantization: quantization}
Michael Yang's avatar
Michael Yang committed
149
	if err := client.Create(cmd.Context(), &request, fn); err != nil {
150
151
152
153
154
155
		return err
	}

	return nil
}

Michael Yang's avatar
Michael Yang committed
156
157
158
159
160
161
162
163
164
165
func tempZipFiles(path string) (string, error) {
	tempfile, err := os.CreateTemp("", "ollama-tf")
	if err != nil {
		return "", err
	}
	defer tempfile.Close()

	zipfile := zip.NewWriter(tempfile)
	defer zipfile.Close()

Michael Yang's avatar
Michael Yang committed
166
167
	detectContentType := func(path string) (string, error) {
		f, err := os.Open(path)
Michael Yang's avatar
Michael Yang committed
168
169
170
		if err != nil {
			return "", err
		}
Michael Yang's avatar
Michael Yang committed
171
		defer f.Close()
Michael Yang's avatar
Michael Yang committed
172

Michael Yang's avatar
Michael Yang committed
173
174
		var b bytes.Buffer
		b.Grow(512)
Michael Yang's avatar
Michael Yang committed
175

Michael Yang's avatar
Michael Yang committed
176
177
178
179
180
181
		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
182
183
	}

Michael Yang's avatar
Michael Yang committed
184
185
186
187
188
189
190
191
192
193
194
	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
195
			}
Michael Yang's avatar
Michael Yang committed
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
		}

		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...)
	} 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...)
	} else if pt, _ := glob(filepath.Join(path, "consolidated*.pth"), "application/octet-stream"); len(pt) > 0 {
		// pytorch files might also be unresolved git lfs references; skip if they are
		// covers consolidated.x.pth, consolidated.pth
		files = append(files, pt...)
	} else {
		return "", errors.New("no safetensors or torch files found")
	}

	// 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...)

	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...)
	}

	for _, file := range files {
		f, err := os.Open(file)
		if err != nil {
Michael Yang's avatar
Michael Yang committed
237
238
			return "", err
		}
Michael Yang's avatar
Michael Yang committed
239
		defer f.Close()
Michael Yang's avatar
Michael Yang committed
240
241
242
243
244
245

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

Michael Yang's avatar
Michael Yang committed
246
		zfi, err := zip.FileInfoHeader(fi)
Michael Yang's avatar
Michael Yang committed
247
248
249
250
		if err != nil {
			return "", err
		}

Michael Yang's avatar
Michael Yang committed
251
		zf, err := zipfile.CreateHeader(zfi)
Michael Yang's avatar
Michael Yang committed
252
253
254
255
		if err != nil {
			return "", err
		}

Michael Yang's avatar
Michael Yang committed
256
		if _, err := io.Copy(zf, f); err != nil {
Michael Yang's avatar
Michael Yang committed
257
258
259
260
261
262
263
			return "", err
		}
	}

	return tempfile.Name(), nil
}

264
265
266
267
268
269
270
271
272
273
274
func createBlob(cmd *cobra.Command, client *api.Client, path string) (string, error) {
	bin, err := os.Open(path)
	if err != nil {
		return "", err
	}
	defer bin.Close()

	hash := sha256.New()
	if _, err := io.Copy(hash, bin); err != nil {
		return "", err
	}
275
276
277
278

	if _, err := bin.Seek(0, io.SeekStart); err != nil {
		return "", err
	}
279
280
281
282
283
284
285
286

	digest := fmt.Sprintf("sha256:%x", hash.Sum(nil))
	if err = client.CreateBlob(cmd.Context(), digest, bin); err != nil {
		return "", err
	}
	return digest, nil
}

287
func RunHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
288
	client, err := api.ClientFromEnvironment()
289
290
291
292
	if err != nil {
		return err
	}

293
	name := args[0]
294

295
	// check if the model exists on the server
296
	show, err := client.Show(cmd.Context(), &api.ShowRequest{Name: name})
Michael Yang's avatar
Michael Yang committed
297
298
299
	var statusError api.StatusError
	switch {
	case errors.As(err, &statusError) && statusError.StatusCode == http.StatusNotFound:
300
		if err := PullHandler(cmd, []string{name}); err != nil {
301
			return err
Michael Yang's avatar
Michael Yang committed
302
		}
303
304
305
306
307

		show, err = client.Show(cmd.Context(), &api.ShowRequest{Name: name})
		if err != nil {
			return err
		}
Michael Yang's avatar
Michael Yang committed
308
309
	case err != nil:
		return err
310
311
	}

312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
	interactive := true

	opts := runOptions{
		Model:       args[0],
		WordWrap:    os.Getenv("TERM") == "xterm-256color",
		Options:     map[string]interface{}{},
		MultiModal:  slices.Contains(show.Details.Families, "clip"),
		ParentModel: show.Details.ParentModel,
	}

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

	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
	}

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

	if !interactive {
		return generate(cmd, opts)
	}

	return generateInteractive(cmd, opts)
Bruce MacDonald's avatar
Bruce MacDonald committed
356
357
}

358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
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
}

399
func PushHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
400
	client, err := api.ClientFromEnvironment()
401
402
403
	if err != nil {
		return err
	}
404

405
406
407
408
409
	insecure, err := cmd.Flags().GetBool("insecure")
	if err != nil {
		return err
	}

Michael Yang's avatar
Michael Yang committed
410
411
412
413
	p := progress.NewProgress(os.Stderr)
	defer p.Stop()

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

417
	fn := func(resp api.ProgressResponse) error {
Michael Yang's avatar
Michael Yang committed
418
		if resp.Digest != "" {
419
420
421
			if spinner != nil {
				spinner.Stop()
			}
Michael Yang's avatar
Michael Yang committed
422
423
424

			bar, ok := bars[resp.Digest]
			if !ok {
425
				bar = progress.NewBar(fmt.Sprintf("pushing %s...", resp.Digest[7:19]), resp.Total, resp.Completed)
Michael Yang's avatar
Michael Yang committed
426
427
428
429
430
431
				bars[resp.Digest] = bar
				p.Add(resp.Digest, bar)
			}

			bar.Set(resp.Completed)
		} else if status != resp.Status {
432
433
434
			if spinner != nil {
				spinner.Stop()
			}
Michael Yang's avatar
Michael Yang committed
435
436
437
438
439
440

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

441
442
443
		return nil
	}

Michael Yang's avatar
Michael Yang committed
444
	request := api.PushRequest{Name: args[0], Insecure: insecure}
Michael Yang's avatar
Michael Yang committed
445
	if err := client.Push(cmd.Context(), &request, fn); err != nil {
446
447
448
449
450
451
452
453
454
455
456
457
458
459
		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
460
461
462
		return err
	}

463
	spinner.Stop()
Michael Yang's avatar
Michael Yang committed
464
	return nil
465
466
}

467
func ListHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
468
	client, err := api.ClientFromEnvironment()
469
470
471
	if err != nil {
		return err
	}
Patrick Devine's avatar
Patrick Devine committed
472

Michael Yang's avatar
Michael Yang committed
473
	models, err := client.List(cmd.Context())
Patrick Devine's avatar
Patrick Devine committed
474
475
476
477
478
479
480
	if err != nil {
		return err
	}

	var data [][]string

	for _, m := range models.Models {
Michael Yang's avatar
Michael Yang committed
481
		if len(args) == 0 || strings.HasPrefix(m.Name, args[0]) {
482
			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
483
		}
Patrick Devine's avatar
Patrick Devine committed
484
485
486
	}

	table := tablewriter.NewWriter(os.Stdout)
Patrick Devine's avatar
Patrick Devine committed
487
	table.SetHeader([]string{"NAME", "ID", "SIZE", "MODIFIED"})
Patrick Devine's avatar
Patrick Devine committed
488
489
490
491
492
493
494
495
496
497
498
499
	table.SetHeaderAlignment(tablewriter.ALIGN_LEFT)
	table.SetAlignment(tablewriter.ALIGN_LEFT)
	table.SetHeaderLine(false)
	table.SetBorder(false)
	table.SetNoWhiteSpace(true)
	table.SetTablePadding("\t")
	table.AppendBulk(data)
	table.Render()

	return nil
}

500
func DeleteHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
501
	client, err := api.ClientFromEnvironment()
502
503
504
	if err != nil {
		return err
	}
505

506
507
	for _, name := range args {
		req := api.DeleteRequest{Name: name}
Michael Yang's avatar
Michael Yang committed
508
		if err := client.Delete(cmd.Context(), &req); err != nil {
509
510
511
			return err
		}
		fmt.Printf("deleted '%s'\n", name)
512
513
514
515
	}
	return nil
}

Patrick Devine's avatar
Patrick Devine committed
516
func ShowHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
517
	client, err := api.ClientFromEnvironment()
Patrick Devine's avatar
Patrick Devine committed
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
560
561
562
563
564
565
566
	if err != nil {
		return err
	}

	if len(args) != 1 {
		return errors.New("missing model name")
	}

	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 {
567
		return errors.New("only one of '--license', '--modelfile', '--parameters', '--system', or '--template' can be specified")
Patrick Devine's avatar
Patrick Devine committed
568
	} else if flagsSet == 0 {
569
		return errors.New("one of '--license', '--modelfile', '--parameters', '--system', or '--template' must be specified")
Patrick Devine's avatar
Patrick Devine committed
570
571
	}

572
	req := api.ShowRequest{Name: args[0]}
Michael Yang's avatar
Michael Yang committed
573
	resp, err := client.Show(cmd.Context(), &req)
Patrick Devine's avatar
Patrick Devine committed
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
	if err != nil {
		return err
	}

	switch showType {
	case "license":
		fmt.Println(resp.License)
	case "modelfile":
		fmt.Println(resp.Modelfile)
	case "parameters":
		fmt.Println(resp.Parameters)
	case "system":
		fmt.Println(resp.System)
	case "template":
		fmt.Println(resp.Template)
	}

	return nil
}

Patrick Devine's avatar
Patrick Devine committed
594
func CopyHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
595
	client, err := api.ClientFromEnvironment()
596
597
598
	if err != nil {
		return err
	}
Patrick Devine's avatar
Patrick Devine committed
599
600

	req := api.CopyRequest{Source: args[0], Destination: args[1]}
Michael Yang's avatar
Michael Yang committed
601
	if err := client.Copy(cmd.Context(), &req); err != nil {
Patrick Devine's avatar
Patrick Devine committed
602
603
604
605
606
607
		return err
	}
	fmt.Printf("copied '%s' to '%s'\n", args[0], args[1])
	return nil
}

608
func PullHandler(cmd *cobra.Command, args []string) error {
609
610
611
612
613
	insecure, err := cmd.Flags().GetBool("insecure")
	if err != nil {
		return err
	}

Michael Yang's avatar
Michael Yang committed
614
	client, err := api.ClientFromEnvironment()
615
616
617
	if err != nil {
		return err
	}
618

Michael Yang's avatar
Michael Yang committed
619
620
621
622
623
	p := progress.NewProgress(os.Stderr)
	defer p.Stop()

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

624
625
	var status string
	var spinner *progress.Spinner
Michael Yang's avatar
Michael Yang committed
626

627
	fn := func(resp api.ProgressResponse) error {
Michael Yang's avatar
Michael Yang committed
628
		if resp.Digest != "" {
629
630
631
			if spinner != nil {
				spinner.Stop()
			}
Michael Yang's avatar
Michael Yang committed
632
633
634

			bar, ok := bars[resp.Digest]
			if !ok {
635
				bar = progress.NewBar(fmt.Sprintf("pulling %s...", resp.Digest[7:19]), resp.Total, resp.Completed)
Michael Yang's avatar
Michael Yang committed
636
637
638
639
640
641
				bars[resp.Digest] = bar
				p.Add(resp.Digest, bar)
			}

			bar.Set(resp.Completed)
		} else if status != resp.Status {
642
643
644
			if spinner != nil {
				spinner.Stop()
			}
Michael Yang's avatar
Michael Yang committed
645
646
647
648
649
650

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

651
652
		return nil
	}
653

Michael Yang's avatar
Michael Yang committed
654
	request := api.PullRequest{Name: args[0], Insecure: insecure}
Michael Yang's avatar
Michael Yang committed
655
	if err := client.Pull(cmd.Context(), &request, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
656
657
658
659
		return err
	}

	return nil
Michael Yang's avatar
Michael Yang committed
660
661
}

662
663
type generateContextKey string

664
type runOptions struct {
665
666
667
668
669
670
671
672
673
674
675
	Model       string
	ParentModel string
	Prompt      string
	Messages    []api.Message
	WordWrap    bool
	Format      string
	System      string
	Template    string
	Images      []api.ImageData
	Options     map[string]interface{}
	MultiModal  bool
676
677
}

678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
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
789
790
791
792
793
794
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 {
			if state.lineLength+1 > termWidth-5 {
				if len(state.wordBuffer) > termWidth-10 {
					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
				fmt.Printf("\x1b[%dD\x1b[K\n", len(state.wordBuffer))
				fmt.Printf("%s%c", state.wordBuffer, ch)
				state.lineLength = len(state.wordBuffer) + 1
			} else {
				fmt.Print(string(ch))
				state.lineLength += 1

				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,
	}

	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
795
	client, err := api.ClientFromEnvironment()
Patrick Devine's avatar
Patrick Devine committed
796
	if err != nil {
797
		return err
Patrick Devine's avatar
Patrick Devine committed
798
	}
Michael Yang's avatar
Michael Yang committed
799

Michael Yang's avatar
Michael Yang committed
800
	p := progress.NewProgress(os.Stderr)
801
	defer p.StopAndClear()
802

Michael Yang's avatar
Michael Yang committed
803
804
805
	spinner := progress.NewSpinner("")
	p.Add("", spinner)

806
807
808
809
810
811
812
	var latest api.GenerateResponse

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

Michael Yang's avatar
Michael Yang committed
813
	ctx, cancel := context.WithCancel(cmd.Context())
814
815
816
817
818
819
820
821
822
823
	defer cancel()

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

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

824
	var state *displayResponseState = &displayResponseState{}
825

826
	fn := func(response api.GenerateResponse) error {
Michael Yang's avatar
Michael Yang committed
827
		p.StopAndClear()
828

Patrick Devine's avatar
Patrick Devine committed
829
		latest = response
830
		content := response.Response
831

832
		displayResponse(content, opts.WordWrap, state)
833

Patrick Devine's avatar
Patrick Devine committed
834
835
		return nil
	}
836

837
838
839
840
841
842
843
	if opts.MultiModal {
		opts.Prompt, opts.Images, err = extractFileData(opts.Prompt)
		if err != nil {
			return err
		}
	}

Michael Yang's avatar
Michael Yang committed
844
845
846
847
	request := api.GenerateRequest{
		Model:    opts.Model,
		Prompt:   opts.Prompt,
		Context:  generateContext,
848
		Images:   opts.Images,
Michael Yang's avatar
Michael Yang committed
849
850
851
852
853
854
855
		Format:   opts.Format,
		System:   opts.System,
		Template: opts.Template,
		Options:  opts.Options,
	}

	if err := client.Generate(ctx, &request, fn); err != nil {
856
		if errors.Is(err, context.Canceled) {
857
			return nil
858
		}
859
		return err
Patrick Devine's avatar
Patrick Devine committed
860
	}
861

862
	if opts.Prompt != "" {
Michael Yang's avatar
Michael Yang committed
863
864
		fmt.Println()
		fmt.Println()
Patrick Devine's avatar
Patrick Devine committed
865
	}
866

867
868
869
870
	if !latest.Done {
		return nil
	}

Patrick Devine's avatar
Patrick Devine committed
871
872
	verbose, err := cmd.Flags().GetBool("verbose")
	if err != nil {
873
		return err
Patrick Devine's avatar
Patrick Devine committed
874
	}
Michael Yang's avatar
Michael Yang committed
875

Patrick Devine's avatar
Patrick Devine committed
876
877
	if verbose {
		latest.Summary()
Michael Yang's avatar
Michael Yang committed
878
	}
Michael Yang's avatar
Michael Yang committed
879

Patrick Devine's avatar
Patrick Devine committed
880
881
882
	ctx = context.WithValue(cmd.Context(), generateContextKey("context"), latest.Context)
	cmd.SetContext(ctx)

883
	return nil
Michael Yang's avatar
Michael Yang committed
884
885
}

886
func RunServer(cmd *cobra.Command, _ []string) error {
887
888
	// retrieve the OLLAMA_HOST environment variable
	ollamaHost, err := api.GetOllamaHost()
Michael Yang's avatar
Michael Yang committed
889
	if err != nil {
890
		return err
Jeffrey Morgan's avatar
Jeffrey Morgan committed
891
	}
892

Michael Yang's avatar
Michael Yang committed
893
	if err := initializeKeypair(); err != nil {
894
895
896
		return err
	}

897
	ln, err := net.Listen("tcp", net.JoinHostPort(ollamaHost.Host, ollamaHost.Port))
898
899
900
	if err != nil {
		return err
	}
Jeffrey Morgan's avatar
Jeffrey Morgan committed
901

902
	return server.Serve(ln)
Jeffrey Morgan's avatar
Jeffrey Morgan committed
903
904
}

905
906
907
908
909
910
911
912
913
914
915
916
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
917
		cryptoPublicKey, cryptoPrivateKey, err := ed25519.GenerateKey(rand.Reader)
918
919
920
921
		if err != nil {
			return err
		}

Michael Yang's avatar
Michael Yang committed
922
		privateKeyBytes, err := ssh.MarshalPrivateKey(cryptoPrivateKey, "")
923
924
925
926
		if err != nil {
			return err
		}

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

Michael Yang's avatar
Michael Yang committed
931
		if err := os.WriteFile(privKeyPath, pem.EncodeToMemory(privateKeyBytes), 0o600); err != nil {
932
933
934
			return err
		}

Michael Yang's avatar
Michael Yang committed
935
		sshPublicKey, err := ssh.NewPublicKey(cryptoPublicKey)
936
937
938
939
		if err != nil {
			return err
		}

Michael Yang's avatar
Michael Yang committed
940
		publicKeyBytes := ssh.MarshalAuthorizedKey(sshPublicKey)
941

Michael Yang's avatar
Michael Yang committed
942
		if err := os.WriteFile(pubKeyPath, publicKeyBytes, 0o644); err != nil {
943
944
945
			return err
		}

Michael Yang's avatar
Michael Yang committed
946
		fmt.Printf("Your new public key is: \n\n%s\n", publicKeyBytes)
947
948
949
950
	}
	return nil
}

951
952
//nolint:unused
func waitForServer(ctx context.Context, client *api.Client) error {
Bruce MacDonald's avatar
Bruce MacDonald committed
953
954
955
956
957
958
959
960
	// wait for the server to start
	timeout := time.After(5 * time.Second)
	tick := time.Tick(500 * time.Millisecond)
	for {
		select {
		case <-timeout:
			return errors.New("timed out waiting for server to start")
		case <-tick:
Michael Yang's avatar
Michael Yang committed
961
			if err := client.Heartbeat(ctx); err == nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
962
963
964
965
				return nil // server has started
			}
		}
	}
966

Bruce MacDonald's avatar
Bruce MacDonald committed
967
968
}

Michael Yang's avatar
Michael Yang committed
969
func checkServerHeartbeat(cmd *cobra.Command, _ []string) error {
Michael Yang's avatar
Michael Yang committed
970
	client, err := api.ClientFromEnvironment()
971
972
973
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
974
	if err := client.Heartbeat(cmd.Context()); err != nil {
975
		if !strings.Contains(err.Error(), " refused") {
Bruce MacDonald's avatar
Bruce MacDonald committed
976
977
			return err
		}
978
979
		if err := startApp(cmd.Context(), client); err != nil {
			return fmt.Errorf("could not connect to ollama app, is it running?")
980
981
982
983
984
		}
	}
	return nil
}

Michael Yang's avatar
Michael Yang committed
985
986
987
988
989
990
991
992
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
993
994
995
996
997
		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
998
999
	}

1000
	if serverVersion != version.Version {
Michael Yang's avatar
Michael Yang committed
1001
		fmt.Printf("Warning: client version is %s\n", version.Version)
1002
	}
Michael Yang's avatar
Michael Yang committed
1003
1004
}

1005
1006
1007
1008
1009
1010
1011
1012
func appendHostEnvDocs(cmd *cobra.Command) {
	const hostEnvDocs = `
Environment Variables:
      OLLAMA_HOST        The host:port or base URL of the Ollama server (e.g. http://localhost:11434)
`
	cmd.SetUsageTemplate(cmd.UsageTemplate() + hostEnvDocs)
}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1013
1014
func NewCLI() *cobra.Command {
	log.SetFlags(log.LstdFlags | log.Lshortfile)
Michael Yang's avatar
Michael Yang committed
1015
	cobra.EnableCommandSorting = false
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1016

1017
	if runtime.GOOS == "windows" {
1018
		console.ConsoleFromFile(os.Stdin) //nolint:errcheck
1019
1020
	}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1021
	rootCmd := &cobra.Command{
1022
1023
1024
1025
		Use:           "ollama",
		Short:         "Large language model runner",
		SilenceUsage:  true,
		SilenceErrors: true,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1026
1027
1028
		CompletionOptions: cobra.CompletionOptions{
			DisableDefaultCmd: true,
		},
Michael Yang's avatar
Michael Yang committed
1029
1030
1031
1032
1033
1034
1035
1036
		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
1037
1038
	}

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

1041
	createCmd := &cobra.Command{
1042
1043
		Use:     "create MODEL",
		Short:   "Create a model from a Modelfile",
Michael Yang's avatar
Michael Yang committed
1044
		Args:    cobra.ExactArgs(1),
1045
1046
		PreRunE: checkServerHeartbeat,
		RunE:    CreateHandler,
1047
1048
1049
	}

	createCmd.Flags().StringP("file", "f", "Modelfile", "Name of the Modelfile (default \"Modelfile\")")
Michael Yang's avatar
Michael Yang committed
1050
	createCmd.Flags().StringP("quantization", "q", "", "Quantization level.")
1051

Patrick Devine's avatar
Patrick Devine committed
1052
1053
1054
	showCmd := &cobra.Command{
		Use:     "show MODEL",
		Short:   "Show information for a model",
Michael Yang's avatar
Michael Yang committed
1055
		Args:    cobra.ExactArgs(1),
Patrick Devine's avatar
Patrick Devine committed
1056
1057
1058
1059
1060
1061
1062
1063
		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")
1064
	showCmd.Flags().Bool("system", false, "Show system message of a model")
Patrick Devine's avatar
Patrick Devine committed
1065

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1066
	runCmd := &cobra.Command{
1067
1068
1069
1070
1071
		Use:     "run MODEL [PROMPT]",
		Short:   "Run a model",
		Args:    cobra.MinimumNArgs(1),
		PreRunE: checkServerHeartbeat,
		RunE:    RunHandler,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1072
1073
	}

1074
	runCmd.Flags().Bool("verbose", false, "Show timings for response")
1075
	runCmd.Flags().Bool("insecure", false, "Use an insecure registry")
1076
	runCmd.Flags().Bool("nowordwrap", false, "Don't wrap words to the next line automatically")
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1077
	runCmd.Flags().String("format", "", "Response format (e.g. json)")
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1078
1079
1080
1081
	serveCmd := &cobra.Command{
		Use:     "serve",
		Aliases: []string{"start"},
		Short:   "Start ollama",
Michael Yang's avatar
Michael Yang committed
1082
		Args:    cobra.ExactArgs(0),
Michael Yang's avatar
Michael Yang committed
1083
		RunE:    RunServer,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1084
	}
1085
1086
1087
	serveCmd.SetUsageTemplate(serveCmd.UsageTemplate() + `
Environment Variables:

1088
1089
1090
1091
    OLLAMA_HOST         The host:port to bind to (default "127.0.0.1:11434")
    OLLAMA_ORIGINS      A comma separated list of allowed origins.
    OLLAMA_MODELS       The path to the models directory (default is "~/.ollama/models")
    OLLAMA_KEEP_ALIVE   The duration that models stay loaded in memory (default is "5m")
1092
    OLLAMA_DEBUG        Set to 1 to enable additional debug logging
1093
`)
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1094

1095
	pullCmd := &cobra.Command{
1096
1097
		Use:     "pull MODEL",
		Short:   "Pull a model from a registry",
Michael Yang's avatar
Michael Yang committed
1098
		Args:    cobra.ExactArgs(1),
1099
1100
		PreRunE: checkServerHeartbeat,
		RunE:    PullHandler,
1101
1102
	}

1103
1104
	pullCmd.Flags().Bool("insecure", false, "Use an insecure registry")

1105
	pushCmd := &cobra.Command{
1106
1107
		Use:     "push MODEL",
		Short:   "Push a model to a registry",
Michael Yang's avatar
Michael Yang committed
1108
		Args:    cobra.ExactArgs(1),
1109
1110
		PreRunE: checkServerHeartbeat,
		RunE:    PushHandler,
1111
1112
	}

1113
1114
	pushCmd.Flags().Bool("insecure", false, "Use an insecure registry")

Patrick Devine's avatar
Patrick Devine committed
1115
	listCmd := &cobra.Command{
1116
		Use:     "list",
Patrick Devine's avatar
Patrick Devine committed
1117
		Aliases: []string{"ls"},
1118
		Short:   "List models",
1119
		PreRunE: checkServerHeartbeat,
1120
		RunE:    ListHandler,
1121
	}
Patrick Devine's avatar
Patrick Devine committed
1122
	copyCmd := &cobra.Command{
Michael Yang's avatar
Michael Yang committed
1123
		Use:     "cp SOURCE TARGET",
1124
		Short:   "Copy a model",
Michael Yang's avatar
Michael Yang committed
1125
		Args:    cobra.ExactArgs(2),
1126
1127
		PreRunE: checkServerHeartbeat,
		RunE:    CopyHandler,
Patrick Devine's avatar
Patrick Devine committed
1128
1129
	}

1130
	deleteCmd := &cobra.Command{
Michael Yang's avatar
Michael Yang committed
1131
		Use:     "rm MODEL [MODEL...]",
1132
1133
1134
1135
		Short:   "Remove a model",
		Args:    cobra.MinimumNArgs(1),
		PreRunE: checkServerHeartbeat,
		RunE:    DeleteHandler,
Patrick Devine's avatar
Patrick Devine committed
1136
1137
	}

1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
	for _, cmd := range []*cobra.Command{
		createCmd,
		showCmd,
		runCmd,
		pullCmd,
		pushCmd,
		listCmd,
		copyCmd,
		deleteCmd,
	} {
		appendHostEnvDocs(cmd)
	}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1151
1152
	rootCmd.AddCommand(
		serveCmd,
1153
		createCmd,
Patrick Devine's avatar
Patrick Devine committed
1154
		showCmd,
1155
		runCmd,
1156
1157
		pullCmd,
		pushCmd,
Patrick Devine's avatar
Patrick Devine committed
1158
		listCmd,
Patrick Devine's avatar
Patrick Devine committed
1159
		copyCmd,
1160
		deleteCmd,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1161
1162
1163
1164
	)

	return rootCmd
}