cmd.go 23.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"
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
35
36
37
38
39
	"github.com/ollama/ollama/api"
	"github.com/ollama/ollama/format"
	"github.com/ollama/ollama/parser"
	"github.com/ollama/ollama/progress"
	"github.com/ollama/ollama/server"
	"github.com/ollama/ollama/version"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
40
41
)

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

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

Michael Yang's avatar
Michael Yang committed
54
55
56
	p := progress.NewProgress(os.Stderr)
	defer p.Stop()

Michael Yang's avatar
Michael Yang committed
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
	modelfile, err := os.ReadFile(filename)
	if err != nil {
		return err
	}

	commands, err := parser.Parse(bytes.NewReader(modelfile))
	if err != nil {
		return err
	}

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

72
73
	status := "transferring model data"
	spinner := progress.NewSpinner(status)
74
75
	p.Add(status, spinner)

Michael Yang's avatar
Michael Yang committed
76
77
78
79
80
81
82
83
84
85
	for _, c := range commands {
		switch c.Name {
		case "model", "adapter":
			path := c.Args
			if path == "~" {
				path = home
			} else if strings.HasPrefix(path, "~/") {
				path = filepath.Join(home, path[2:])
			}

86
87
88
89
			if !filepath.IsAbs(path) {
				path = filepath.Join(filepath.Dir(filename), path)
			}

90
			fi, err := os.Stat(path)
Michael Yang's avatar
Michael Yang committed
91
			if errors.Is(err, os.ErrNotExist) && c.Name == "model" {
Michael Yang's avatar
Michael Yang committed
92
				continue
Michael Yang's avatar
Michael Yang committed
93
94
95
96
			} else if err != nil {
				return err
			}

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

Michael Yang's avatar
Michael Yang committed
106
				path = tempfile
Michael Yang's avatar
Michael Yang committed
107
108
			}

109
110
			digest, err := createBlob(cmd, client, path)
			if err != nil {
Michael Yang's avatar
Michael Yang committed
111
112
113
				return err
			}

114
115
116
117
118
119
120
			name := c.Name
			if c.Name == "model" {
				name = "from"
			}

			re := regexp.MustCompile(fmt.Sprintf(`(?im)^(%s)\s+%s\s*$`, name, c.Args))
			modelfile = re.ReplaceAll(modelfile, []byte("$1 @"+digest))
Michael Yang's avatar
Michael Yang committed
121
122
		}
	}
Michael Yang's avatar
Michael Yang committed
123

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

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

145
146
147
		return nil
	}

Michael Yang's avatar
Michael Yang committed
148
149
150
	quantization, _ := cmd.Flags().GetString("quantization")

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

	return nil
}

Michael Yang's avatar
Michael Yang committed
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
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
237
238
239
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()

	tfiles, err := filepath.Glob(filepath.Join(path, "pytorch_model-*.bin"))
	if err != nil {
		return "", err
	} else if len(tfiles) == 0 {
		tfiles, err = filepath.Glob(filepath.Join(path, "model-*.safetensors"))
		if err != nil {
			return "", err
		}
	}

	files := []string{}
	files = append(files, tfiles...)

	if len(files) == 0 {
		return "", fmt.Errorf("no models were found in '%s'", path)
	}

	// add the safetensor/torch config file + tokenizer
	files = append(files, filepath.Join(path, "config.json"))
	files = append(files, filepath.Join(path, "params.json"))
	files = append(files, filepath.Join(path, "added_tokens.json"))
	files = append(files, filepath.Join(path, "tokenizer.model"))

	for _, fn := range files {
		f, err := os.Open(fn)

		// just skip whatever files aren't there
		if os.IsNotExist(err) {
			if strings.HasSuffix(fn, "tokenizer.model") {
				// try the parent dir before giving up
				parentDir := filepath.Dir(path)
				newFn := filepath.Join(parentDir, "tokenizer.model")
				f, err = os.Open(newFn)
				if os.IsNotExist(err) {
					continue
				} else if err != nil {
					return "", err
				}
			} else {
				continue
			}
		} else if err != nil {
			return "", err
		}

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

		h, err := zip.FileInfoHeader(fi)
		if err != nil {
			return "", err
		}

		h.Name = filepath.Base(fn)
		h.Method = zip.Store

		w, err := zipfile.CreateHeader(h)
		if err != nil {
			return "", err
		}

		_, err = io.Copy(w, f)
		if err != nil {
			return "", err
		}
	}

	return tempfile.Name(), nil
}

240
241
242
243
244
245
246
247
248
249
250
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
	}
251
252
253
254

	if _, err := bin.Seek(0, io.SeekStart); err != nil {
		return "", err
	}
255
256
257
258
259
260
261
262

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

263
func RunHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
264
	client, err := api.ClientFromEnvironment()
265
266
267
268
	if err != nil {
		return err
	}

269
	name := args[0]
270

271
	// check if the model exists on the server
272
	show, err := client.Show(cmd.Context(), &api.ShowRequest{Name: name})
Michael Yang's avatar
Michael Yang committed
273
274
275
	var statusError api.StatusError
	switch {
	case errors.As(err, &statusError) && statusError.StatusCode == http.StatusNotFound:
276
		if err := PullHandler(cmd, []string{name}); err != nil {
277
			return err
Michael Yang's avatar
Michael Yang committed
278
		}
279
280
281
282
283

		show, err = client.Show(cmd.Context(), &api.ShowRequest{Name: name})
		if err != nil {
			return err
		}
Michael Yang's avatar
Michael Yang committed
284
285
	case err != nil:
		return err
286
287
	}

288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
	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
332
333
}

334
func PushHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
335
	client, err := api.ClientFromEnvironment()
336
337
338
	if err != nil {
		return err
	}
339

340
341
342
343
344
	insecure, err := cmd.Flags().GetBool("insecure")
	if err != nil {
		return err
	}

Michael Yang's avatar
Michael Yang committed
345
346
347
348
	p := progress.NewProgress(os.Stderr)
	defer p.Stop()

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

352
	fn := func(resp api.ProgressResponse) error {
Michael Yang's avatar
Michael Yang committed
353
		if resp.Digest != "" {
354
355
356
			if spinner != nil {
				spinner.Stop()
			}
Michael Yang's avatar
Michael Yang committed
357
358
359

			bar, ok := bars[resp.Digest]
			if !ok {
360
				bar = progress.NewBar(fmt.Sprintf("pushing %s...", resp.Digest[7:19]), resp.Total, resp.Completed)
Michael Yang's avatar
Michael Yang committed
361
362
363
364
365
366
				bars[resp.Digest] = bar
				p.Add(resp.Digest, bar)
			}

			bar.Set(resp.Completed)
		} else if status != resp.Status {
367
368
369
			if spinner != nil {
				spinner.Stop()
			}
Michael Yang's avatar
Michael Yang committed
370
371
372
373
374
375

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

376
377
378
		return nil
	}

Michael Yang's avatar
Michael Yang committed
379
	request := api.PushRequest{Name: args[0], Insecure: insecure}
Michael Yang's avatar
Michael Yang committed
380
	if err := client.Push(cmd.Context(), &request, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
381
382
383
		return err
	}

384
	spinner.Stop()
Michael Yang's avatar
Michael Yang committed
385
	return nil
386
387
}

388
func ListHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
389
	client, err := api.ClientFromEnvironment()
390
391
392
	if err != nil {
		return err
	}
Patrick Devine's avatar
Patrick Devine committed
393

Michael Yang's avatar
Michael Yang committed
394
	models, err := client.List(cmd.Context())
Patrick Devine's avatar
Patrick Devine committed
395
396
397
398
399
400
401
	if err != nil {
		return err
	}

	var data [][]string

	for _, m := range models.Models {
Michael Yang's avatar
Michael Yang committed
402
		if len(args) == 0 || strings.HasPrefix(m.Name, args[0]) {
403
			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
404
		}
Patrick Devine's avatar
Patrick Devine committed
405
406
407
	}

	table := tablewriter.NewWriter(os.Stdout)
Patrick Devine's avatar
Patrick Devine committed
408
	table.SetHeader([]string{"NAME", "ID", "SIZE", "MODIFIED"})
Patrick Devine's avatar
Patrick Devine committed
409
410
411
412
413
414
415
416
417
418
419
420
	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
}

421
func DeleteHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
422
	client, err := api.ClientFromEnvironment()
423
424
425
	if err != nil {
		return err
	}
426

427
428
	for _, name := range args {
		req := api.DeleteRequest{Name: name}
Michael Yang's avatar
Michael Yang committed
429
		if err := client.Delete(cmd.Context(), &req); err != nil {
430
431
432
			return err
		}
		fmt.Printf("deleted '%s'\n", name)
433
434
435
436
	}
	return nil
}

Patrick Devine's avatar
Patrick Devine committed
437
func ShowHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
438
	client, err := api.ClientFromEnvironment()
Patrick Devine's avatar
Patrick Devine committed
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
	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 {
488
		return errors.New("only one of '--license', '--modelfile', '--parameters', '--system', or '--template' can be specified")
Patrick Devine's avatar
Patrick Devine committed
489
	} else if flagsSet == 0 {
490
		return errors.New("one of '--license', '--modelfile', '--parameters', '--system', or '--template' must be specified")
Patrick Devine's avatar
Patrick Devine committed
491
492
	}

493
	req := api.ShowRequest{Name: args[0]}
Michael Yang's avatar
Michael Yang committed
494
	resp, err := client.Show(cmd.Context(), &req)
Patrick Devine's avatar
Patrick Devine committed
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
	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
515
func CopyHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
516
	client, err := api.ClientFromEnvironment()
517
518
519
	if err != nil {
		return err
	}
Patrick Devine's avatar
Patrick Devine committed
520
521

	req := api.CopyRequest{Source: args[0], Destination: args[1]}
Michael Yang's avatar
Michael Yang committed
522
	if err := client.Copy(cmd.Context(), &req); err != nil {
Patrick Devine's avatar
Patrick Devine committed
523
524
525
526
527
528
		return err
	}
	fmt.Printf("copied '%s' to '%s'\n", args[0], args[1])
	return nil
}

529
func PullHandler(cmd *cobra.Command, args []string) error {
530
531
532
533
534
	insecure, err := cmd.Flags().GetBool("insecure")
	if err != nil {
		return err
	}

Michael Yang's avatar
Michael Yang committed
535
	client, err := api.ClientFromEnvironment()
536
537
538
	if err != nil {
		return err
	}
539

Michael Yang's avatar
Michael Yang committed
540
541
542
543
544
	p := progress.NewProgress(os.Stderr)
	defer p.Stop()

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

545
546
	var status string
	var spinner *progress.Spinner
Michael Yang's avatar
Michael Yang committed
547

548
	fn := func(resp api.ProgressResponse) error {
Michael Yang's avatar
Michael Yang committed
549
		if resp.Digest != "" {
550
551
552
			if spinner != nil {
				spinner.Stop()
			}
Michael Yang's avatar
Michael Yang committed
553
554
555

			bar, ok := bars[resp.Digest]
			if !ok {
556
				bar = progress.NewBar(fmt.Sprintf("pulling %s...", resp.Digest[7:19]), resp.Total, resp.Completed)
Michael Yang's avatar
Michael Yang committed
557
558
559
560
561
562
				bars[resp.Digest] = bar
				p.Add(resp.Digest, bar)
			}

			bar.Set(resp.Completed)
		} else if status != resp.Status {
563
564
565
			if spinner != nil {
				spinner.Stop()
			}
Michael Yang's avatar
Michael Yang committed
566
567
568
569
570
571

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

572
573
		return nil
	}
574

Michael Yang's avatar
Michael Yang committed
575
	request := api.PullRequest{Name: args[0], Insecure: insecure}
Michael Yang's avatar
Michael Yang committed
576
	if err := client.Pull(cmd.Context(), &request, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
577
578
579
580
		return err
	}

	return nil
Michael Yang's avatar
Michael Yang committed
581
582
}

583
584
type generateContextKey string

585
type runOptions struct {
586
587
588
589
590
591
592
593
594
595
596
	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
597
598
}

599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
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
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
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
716
	client, err := api.ClientFromEnvironment()
Patrick Devine's avatar
Patrick Devine committed
717
	if err != nil {
718
		return err
Patrick Devine's avatar
Patrick Devine committed
719
	}
Michael Yang's avatar
Michael Yang committed
720

Michael Yang's avatar
Michael Yang committed
721
	p := progress.NewProgress(os.Stderr)
722
	defer p.StopAndClear()
723

Michael Yang's avatar
Michael Yang committed
724
725
726
	spinner := progress.NewSpinner("")
	p.Add("", spinner)

727
728
729
730
731
732
733
	var latest api.GenerateResponse

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

Michael Yang's avatar
Michael Yang committed
734
	ctx, cancel := context.WithCancel(cmd.Context())
735
736
737
738
739
740
741
742
743
744
	defer cancel()

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

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

745
	var state *displayResponseState = &displayResponseState{}
746

747
	fn := func(response api.GenerateResponse) error {
Michael Yang's avatar
Michael Yang committed
748
		p.StopAndClear()
749

Patrick Devine's avatar
Patrick Devine committed
750
		latest = response
751
		content := response.Response
752

753
		displayResponse(content, opts.WordWrap, state)
754

Patrick Devine's avatar
Patrick Devine committed
755
756
		return nil
	}
757

758
759
760
761
762
763
764
	if opts.MultiModal {
		opts.Prompt, opts.Images, err = extractFileData(opts.Prompt)
		if err != nil {
			return err
		}
	}

Michael Yang's avatar
Michael Yang committed
765
766
767
768
	request := api.GenerateRequest{
		Model:    opts.Model,
		Prompt:   opts.Prompt,
		Context:  generateContext,
769
		Images:   opts.Images,
Michael Yang's avatar
Michael Yang committed
770
771
772
773
774
775
776
		Format:   opts.Format,
		System:   opts.System,
		Template: opts.Template,
		Options:  opts.Options,
	}

	if err := client.Generate(ctx, &request, fn); err != nil {
777
		if errors.Is(err, context.Canceled) {
778
			return nil
779
		}
780
		return err
Patrick Devine's avatar
Patrick Devine committed
781
	}
782

783
	if opts.Prompt != "" {
Michael Yang's avatar
Michael Yang committed
784
785
		fmt.Println()
		fmt.Println()
Patrick Devine's avatar
Patrick Devine committed
786
	}
787

788
789
790
791
	if !latest.Done {
		return nil
	}

Patrick Devine's avatar
Patrick Devine committed
792
793
	verbose, err := cmd.Flags().GetBool("verbose")
	if err != nil {
794
		return err
Patrick Devine's avatar
Patrick Devine committed
795
	}
Michael Yang's avatar
Michael Yang committed
796

Patrick Devine's avatar
Patrick Devine committed
797
798
	if verbose {
		latest.Summary()
Michael Yang's avatar
Michael Yang committed
799
	}
Michael Yang's avatar
Michael Yang committed
800

Patrick Devine's avatar
Patrick Devine committed
801
802
803
	ctx = context.WithValue(cmd.Context(), generateContextKey("context"), latest.Context)
	cmd.SetContext(ctx)

804
	return nil
Michael Yang's avatar
Michael Yang committed
805
806
}

807
func RunServer(cmd *cobra.Command, _ []string) error {
808
	host, port, err := net.SplitHostPort(strings.Trim(os.Getenv("OLLAMA_HOST"), "\"'"))
Michael Yang's avatar
Michael Yang committed
809
810
	if err != nil {
		host, port = "127.0.0.1", "11434"
Michael Yang's avatar
Michael Yang committed
811
		if ip := net.ParseIP(strings.Trim(os.Getenv("OLLAMA_HOST"), "[]")); ip != nil {
Michael Yang's avatar
Michael Yang committed
812
813
			host = ip.String()
		}
Jeffrey Morgan's avatar
Jeffrey Morgan committed
814
	}
815

Michael Yang's avatar
Michael Yang committed
816
	if err := initializeKeypair(); err != nil {
817
818
819
		return err
	}

Michael Yang's avatar
Michael Yang committed
820
	ln, err := net.Listen("tcp", net.JoinHostPort(host, port))
821
822
823
	if err != nil {
		return err
	}
Jeffrey Morgan's avatar
Jeffrey Morgan committed
824

825
	return server.Serve(ln)
Jeffrey Morgan's avatar
Jeffrey Morgan committed
826
827
}

828
829
830
831
832
833
834
835
836
837
838
839
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
840
		cryptoPublicKey, cryptoPrivateKey, err := ed25519.GenerateKey(rand.Reader)
841
842
843
844
		if err != nil {
			return err
		}

Michael Yang's avatar
Michael Yang committed
845
		privateKeyBytes, err := ssh.MarshalPrivateKey(cryptoPrivateKey, "")
846
847
848
849
		if err != nil {
			return err
		}

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

Michael Yang's avatar
Michael Yang committed
854
		if err := os.WriteFile(privKeyPath, pem.EncodeToMemory(privateKeyBytes), 0o600); err != nil {
855
856
857
			return err
		}

Michael Yang's avatar
Michael Yang committed
858
		sshPublicKey, err := ssh.NewPublicKey(cryptoPublicKey)
859
860
861
862
		if err != nil {
			return err
		}

Michael Yang's avatar
Michael Yang committed
863
		publicKeyBytes := ssh.MarshalAuthorizedKey(sshPublicKey)
864

Michael Yang's avatar
Michael Yang committed
865
		if err := os.WriteFile(pubKeyPath, publicKeyBytes, 0o644); err != nil {
866
867
868
			return err
		}

Michael Yang's avatar
Michael Yang committed
869
		fmt.Printf("Your new public key is: \n\n%s\n", publicKeyBytes)
870
871
872
873
	}
	return nil
}

874
875
//nolint:unused
func waitForServer(ctx context.Context, client *api.Client) error {
Bruce MacDonald's avatar
Bruce MacDonald committed
876
877
878
879
880
881
882
883
	// 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
884
			if err := client.Heartbeat(ctx); err == nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
885
886
887
888
				return nil // server has started
			}
		}
	}
889

Bruce MacDonald's avatar
Bruce MacDonald committed
890
891
}

Michael Yang's avatar
Michael Yang committed
892
func checkServerHeartbeat(cmd *cobra.Command, _ []string) error {
Michael Yang's avatar
Michael Yang committed
893
	client, err := api.ClientFromEnvironment()
894
895
896
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
897
	if err := client.Heartbeat(cmd.Context()); err != nil {
898
		if !strings.Contains(err.Error(), " refused") {
Bruce MacDonald's avatar
Bruce MacDonald committed
899
900
			return err
		}
901
902
		if err := startApp(cmd.Context(), client); err != nil {
			return fmt.Errorf("could not connect to ollama app, is it running?")
903
904
905
906
907
		}
	}
	return nil
}

Michael Yang's avatar
Michael Yang committed
908
909
910
911
912
913
914
915
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
916
917
918
919
920
		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
921
922
	}

923
	if serverVersion != version.Version {
Michael Yang's avatar
Michael Yang committed
924
		fmt.Printf("Warning: client version is %s\n", version.Version)
925
	}
Michael Yang's avatar
Michael Yang committed
926
927
}

928
929
930
931
932
933
934
935
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
936
937
func NewCLI() *cobra.Command {
	log.SetFlags(log.LstdFlags | log.Lshortfile)
Michael Yang's avatar
Michael Yang committed
938
	cobra.EnableCommandSorting = false
Jeffrey Morgan's avatar
Jeffrey Morgan committed
939

940
	if runtime.GOOS == "windows" {
941
		console.ConsoleFromFile(os.Stdin) //nolint:errcheck
942
943
	}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
944
	rootCmd := &cobra.Command{
945
946
947
948
		Use:           "ollama",
		Short:         "Large language model runner",
		SilenceUsage:  true,
		SilenceErrors: true,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
949
950
951
		CompletionOptions: cobra.CompletionOptions{
			DisableDefaultCmd: true,
		},
Michael Yang's avatar
Michael Yang committed
952
953
954
955
956
957
958
959
		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
960
961
	}

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

964
	createCmd := &cobra.Command{
965
966
		Use:     "create MODEL",
		Short:   "Create a model from a Modelfile",
Michael Yang's avatar
Michael Yang committed
967
		Args:    cobra.ExactArgs(1),
968
969
		PreRunE: checkServerHeartbeat,
		RunE:    CreateHandler,
970
971
972
	}

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

Patrick Devine's avatar
Patrick Devine committed
975
976
977
	showCmd := &cobra.Command{
		Use:     "show MODEL",
		Short:   "Show information for a model",
Michael Yang's avatar
Michael Yang committed
978
		Args:    cobra.ExactArgs(1),
Patrick Devine's avatar
Patrick Devine committed
979
980
981
982
983
984
985
986
		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")
987
	showCmd.Flags().Bool("system", false, "Show system message of a model")
Patrick Devine's avatar
Patrick Devine committed
988

Jeffrey Morgan's avatar
Jeffrey Morgan committed
989
	runCmd := &cobra.Command{
990
991
992
993
994
		Use:     "run MODEL [PROMPT]",
		Short:   "Run a model",
		Args:    cobra.MinimumNArgs(1),
		PreRunE: checkServerHeartbeat,
		RunE:    RunHandler,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
995
996
	}

997
	runCmd.Flags().Bool("verbose", false, "Show timings for response")
998
	runCmd.Flags().Bool("insecure", false, "Use an insecure registry")
999
	runCmd.Flags().Bool("nowordwrap", false, "Don't wrap words to the next line automatically")
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1000
	runCmd.Flags().String("format", "", "Response format (e.g. json)")
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1001
1002
1003
1004
	serveCmd := &cobra.Command{
		Use:     "serve",
		Aliases: []string{"start"},
		Short:   "Start ollama",
Michael Yang's avatar
Michael Yang committed
1005
		Args:    cobra.ExactArgs(0),
Michael Yang's avatar
Michael Yang committed
1006
		RunE:    RunServer,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1007
	}
1008
1009
1010
	serveCmd.SetUsageTemplate(serveCmd.UsageTemplate() + `
Environment Variables:

1011
1012
1013
1014
    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")
1015
    OLLAMA_DEBUG        Set to 1 to enable additional debug logging
1016
`)
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1017

1018
	pullCmd := &cobra.Command{
1019
1020
		Use:     "pull MODEL",
		Short:   "Pull a model from a registry",
Michael Yang's avatar
Michael Yang committed
1021
		Args:    cobra.ExactArgs(1),
1022
1023
		PreRunE: checkServerHeartbeat,
		RunE:    PullHandler,
1024
1025
	}

1026
1027
	pullCmd.Flags().Bool("insecure", false, "Use an insecure registry")

1028
	pushCmd := &cobra.Command{
1029
1030
		Use:     "push MODEL",
		Short:   "Push a model to a registry",
Michael Yang's avatar
Michael Yang committed
1031
		Args:    cobra.ExactArgs(1),
1032
1033
		PreRunE: checkServerHeartbeat,
		RunE:    PushHandler,
1034
1035
	}

1036
1037
	pushCmd.Flags().Bool("insecure", false, "Use an insecure registry")

Patrick Devine's avatar
Patrick Devine committed
1038
	listCmd := &cobra.Command{
1039
		Use:     "list",
Patrick Devine's avatar
Patrick Devine committed
1040
		Aliases: []string{"ls"},
1041
		Short:   "List models",
1042
		PreRunE: checkServerHeartbeat,
1043
		RunE:    ListHandler,
1044
	}
Patrick Devine's avatar
Patrick Devine committed
1045
	copyCmd := &cobra.Command{
Michael Yang's avatar
Michael Yang committed
1046
		Use:     "cp SOURCE TARGET",
1047
		Short:   "Copy a model",
Michael Yang's avatar
Michael Yang committed
1048
		Args:    cobra.ExactArgs(2),
1049
1050
		PreRunE: checkServerHeartbeat,
		RunE:    CopyHandler,
Patrick Devine's avatar
Patrick Devine committed
1051
1052
	}

1053
	deleteCmd := &cobra.Command{
Michael Yang's avatar
Michael Yang committed
1054
		Use:     "rm MODEL [MODEL...]",
1055
1056
1057
1058
		Short:   "Remove a model",
		Args:    cobra.MinimumNArgs(1),
		PreRunE: checkServerHeartbeat,
		RunE:    DeleteHandler,
Patrick Devine's avatar
Patrick Devine committed
1059
1060
	}

1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
	for _, cmd := range []*cobra.Command{
		createCmd,
		showCmd,
		runCmd,
		pullCmd,
		pushCmd,
		listCmd,
		copyCmd,
		deleteCmd,
	} {
		appendHostEnvDocs(cmd)
	}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1074
1075
	rootCmd.AddCommand(
		serveCmd,
1076
		createCmd,
Patrick Devine's avatar
Patrick Devine committed
1077
		showCmd,
1078
		runCmd,
1079
1080
		pullCmd,
		pushCmd,
Patrick Devine's avatar
Patrick Devine committed
1081
		listCmd,
Patrick Devine's avatar
Patrick Devine committed
1082
		copyCmd,
1083
		deleteCmd,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1084
1085
1086
1087
	)

	return rootCmd
}