cmd.go 22.8 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
	"runtime"
Michael Yang's avatar
Michael Yang committed
21
	"strings"
22
	"syscall"
Michael Yang's avatar
Michael Yang committed
23
	"time"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
24

25
26
	"github.com/containerd/console"

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

33
34
35
36
37
38
	"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
39
40
)

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

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

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

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

Michael Yang's avatar
Michael Yang committed
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
	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
	}

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

Michael Yang's avatar
Michael Yang committed
77
78
79
80
81
82
83
84
85
86
	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:])
			}

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

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

98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
			// TODO make this work w/ adapters
			if fi.IsDir() {
				tf, err := os.CreateTemp("", "ollama-tf")
				if err != nil {
					return err
				}
				defer os.RemoveAll(tf.Name())

				zf := zip.NewWriter(tf)

				files, err := filepath.Glob(filepath.Join(path, "model-*.safetensors"))
				if err != nil {
					return err
				}

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

				// add the safetensor config file + tokenizer
				files = append(files, filepath.Join(path, "config.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)
					if os.IsNotExist(err) && strings.HasSuffix(fn, "added_tokens.json") {
						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 := zf.CreateHeader(h)
					if err != nil {
						return err
					}

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

				}

				if err := zf.Close(); err != nil {
					return err
				}

				if err := tf.Close(); err != nil {
					return err
				}
				path = tf.Name()
Michael Yang's avatar
Michael Yang committed
163
164
			}

165
166
			digest, err := createBlob(cmd, client, path)
			if err != nil {
Michael Yang's avatar
Michael Yang committed
167
168
169
				return err
			}

Michael Yang's avatar
Michael Yang committed
170
			modelfile = bytes.ReplaceAll(modelfile, []byte(c.Args), []byte("@"+digest))
Michael Yang's avatar
Michael Yang committed
171
172
		}
	}
Michael Yang's avatar
Michael Yang committed
173

174
	fn := func(resp api.ProgressResponse) error {
Michael Yang's avatar
Michael Yang committed
175
176
177
178
179
		if resp.Digest != "" {
			spinner.Stop()

			bar, ok := bars[resp.Digest]
			if !ok {
180
				bar = progress.NewBar(fmt.Sprintf("pulling %s...", resp.Digest[7:19]), resp.Total, resp.Completed)
Michael Yang's avatar
Michael Yang committed
181
182
183
184
185
186
187
188
189
190
191
192
193
				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)
		}

194
195
196
		return nil
	}

197
	request := api.CreateRequest{Name: args[0], Modelfile: string(modelfile)}
Michael Yang's avatar
Michael Yang committed
198
	if err := client.Create(cmd.Context(), &request, fn); err != nil {
199
200
201
202
203
204
		return err
	}

	return nil
}

205
206
207
208
209
210
211
212
213
214
215
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
	}
216
217
218
219

	if _, err := bin.Seek(0, io.SeekStart); err != nil {
		return "", err
	}
220
221
222
223
224
225
226
227

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

228
func RunHandler(cmd *cobra.Command, args []string) error {
229
230
231
232
233
234
235
236
	if os.Getenv("OLLAMA_MODELS") != "" {
		return errors.New("OLLAMA_MODELS must only be set for 'ollama serve'")
	}

	if err := checkServerHeartbeat(cmd, args); err != nil {
		return err
	}

Michael Yang's avatar
Michael Yang committed
237
	client, err := api.ClientFromEnvironment()
238
239
240
241
	if err != nil {
		return err
	}

242
	name := args[0]
243

244
	// check if the model exists on the server
245
	show, err := client.Show(cmd.Context(), &api.ShowRequest{Name: name})
Michael Yang's avatar
Michael Yang committed
246
247
248
	var statusError api.StatusError
	switch {
	case errors.As(err, &statusError) && statusError.StatusCode == http.StatusNotFound:
249
		if err := PullHandler(cmd, []string{name}); err != nil {
250
			return err
Michael Yang's avatar
Michael Yang committed
251
		}
252
253
254
255
256

		show, err = client.Show(cmd.Context(), &api.ShowRequest{Name: name})
		if err != nil {
			return err
		}
Michael Yang's avatar
Michael Yang committed
257
258
	case err != nil:
		return err
259
260
	}

261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
	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
305
306
}

307
func PushHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
308
	client, err := api.ClientFromEnvironment()
309
310
311
	if err != nil {
		return err
	}
312

313
314
315
316
317
	insecure, err := cmd.Flags().GetBool("insecure")
	if err != nil {
		return err
	}

Michael Yang's avatar
Michael Yang committed
318
319
320
321
	p := progress.NewProgress(os.Stderr)
	defer p.Stop()

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

325
	fn := func(resp api.ProgressResponse) error {
Michael Yang's avatar
Michael Yang committed
326
		if resp.Digest != "" {
327
328
329
			if spinner != nil {
				spinner.Stop()
			}
Michael Yang's avatar
Michael Yang committed
330
331
332

			bar, ok := bars[resp.Digest]
			if !ok {
333
				bar = progress.NewBar(fmt.Sprintf("pushing %s...", resp.Digest[7:19]), resp.Total, resp.Completed)
Michael Yang's avatar
Michael Yang committed
334
335
336
337
338
339
				bars[resp.Digest] = bar
				p.Add(resp.Digest, bar)
			}

			bar.Set(resp.Completed)
		} else if status != resp.Status {
340
341
342
			if spinner != nil {
				spinner.Stop()
			}
Michael Yang's avatar
Michael Yang committed
343
344
345
346
347
348

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

349
350
351
		return nil
	}

Michael Yang's avatar
Michael Yang committed
352
	request := api.PushRequest{Name: args[0], Insecure: insecure}
Michael Yang's avatar
Michael Yang committed
353
	if err := client.Push(cmd.Context(), &request, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
354
355
356
		return err
	}

357
	spinner.Stop()
Michael Yang's avatar
Michael Yang committed
358
	return nil
359
360
}

361
func ListHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
362
	client, err := api.ClientFromEnvironment()
363
364
365
	if err != nil {
		return err
	}
Patrick Devine's avatar
Patrick Devine committed
366

Michael Yang's avatar
Michael Yang committed
367
	models, err := client.List(cmd.Context())
Patrick Devine's avatar
Patrick Devine committed
368
369
370
371
372
373
374
	if err != nil {
		return err
	}

	var data [][]string

	for _, m := range models.Models {
Michael Yang's avatar
Michael Yang committed
375
		if len(args) == 0 || strings.HasPrefix(m.Name, args[0]) {
376
			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
377
		}
Patrick Devine's avatar
Patrick Devine committed
378
379
380
	}

	table := tablewriter.NewWriter(os.Stdout)
Patrick Devine's avatar
Patrick Devine committed
381
	table.SetHeader([]string{"NAME", "ID", "SIZE", "MODIFIED"})
Patrick Devine's avatar
Patrick Devine committed
382
383
384
385
386
387
388
389
390
391
392
393
	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
}

394
func DeleteHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
395
	client, err := api.ClientFromEnvironment()
396
397
398
	if err != nil {
		return err
	}
399

400
401
	for _, name := range args {
		req := api.DeleteRequest{Name: name}
Michael Yang's avatar
Michael Yang committed
402
		if err := client.Delete(cmd.Context(), &req); err != nil {
403
404
405
			return err
		}
		fmt.Printf("deleted '%s'\n", name)
406
407
408
409
	}
	return nil
}

Patrick Devine's avatar
Patrick Devine committed
410
func ShowHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
411
	client, err := api.ClientFromEnvironment()
Patrick Devine's avatar
Patrick Devine committed
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
	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 {
461
		return errors.New("only one of '--license', '--modelfile', '--parameters', '--system', or '--template' can be specified")
Patrick Devine's avatar
Patrick Devine committed
462
	} else if flagsSet == 0 {
463
		return errors.New("one of '--license', '--modelfile', '--parameters', '--system', or '--template' must be specified")
Patrick Devine's avatar
Patrick Devine committed
464
465
	}

466
	req := api.ShowRequest{Name: args[0]}
Michael Yang's avatar
Michael Yang committed
467
	resp, err := client.Show(cmd.Context(), &req)
Patrick Devine's avatar
Patrick Devine committed
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
	}

	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
488
func CopyHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
489
	client, err := api.ClientFromEnvironment()
490
491
492
	if err != nil {
		return err
	}
Patrick Devine's avatar
Patrick Devine committed
493
494

	req := api.CopyRequest{Source: args[0], Destination: args[1]}
Michael Yang's avatar
Michael Yang committed
495
	if err := client.Copy(cmd.Context(), &req); err != nil {
Patrick Devine's avatar
Patrick Devine committed
496
497
498
499
500
501
		return err
	}
	fmt.Printf("copied '%s' to '%s'\n", args[0], args[1])
	return nil
}

502
func PullHandler(cmd *cobra.Command, args []string) error {
503
504
505
506
507
	insecure, err := cmd.Flags().GetBool("insecure")
	if err != nil {
		return err
	}

Michael Yang's avatar
Michael Yang committed
508
	client, err := api.ClientFromEnvironment()
509
510
511
	if err != nil {
		return err
	}
512

Michael Yang's avatar
Michael Yang committed
513
514
515
516
517
	p := progress.NewProgress(os.Stderr)
	defer p.Stop()

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

518
519
	var status string
	var spinner *progress.Spinner
Michael Yang's avatar
Michael Yang committed
520

521
	fn := func(resp api.ProgressResponse) error {
Michael Yang's avatar
Michael Yang committed
522
		if resp.Digest != "" {
523
524
525
			if spinner != nil {
				spinner.Stop()
			}
Michael Yang's avatar
Michael Yang committed
526
527
528

			bar, ok := bars[resp.Digest]
			if !ok {
529
				bar = progress.NewBar(fmt.Sprintf("pulling %s...", resp.Digest[7:19]), resp.Total, resp.Completed)
Michael Yang's avatar
Michael Yang committed
530
531
532
533
534
535
				bars[resp.Digest] = bar
				p.Add(resp.Digest, bar)
			}

			bar.Set(resp.Completed)
		} else if status != resp.Status {
536
537
538
			if spinner != nil {
				spinner.Stop()
			}
Michael Yang's avatar
Michael Yang committed
539
540
541
542
543
544

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

545
546
		return nil
	}
547

Michael Yang's avatar
Michael Yang committed
548
	request := api.PullRequest{Name: args[0], Insecure: insecure}
Michael Yang's avatar
Michael Yang committed
549
	if err := client.Pull(cmd.Context(), &request, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
550
551
552
553
		return err
	}

	return nil
Michael Yang's avatar
Michael Yang committed
554
555
}

556
557
type generateContextKey string

558
type runOptions struct {
559
560
561
562
563
564
565
566
567
568
569
	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
570
571
}

572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
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
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
689
	client, err := api.ClientFromEnvironment()
Patrick Devine's avatar
Patrick Devine committed
690
	if err != nil {
691
		return err
Patrick Devine's avatar
Patrick Devine committed
692
	}
Michael Yang's avatar
Michael Yang committed
693

Michael Yang's avatar
Michael Yang committed
694
	p := progress.NewProgress(os.Stderr)
695
	defer p.StopAndClear()
696

Michael Yang's avatar
Michael Yang committed
697
698
699
	spinner := progress.NewSpinner("")
	p.Add("", spinner)

700
701
702
703
704
705
706
	var latest api.GenerateResponse

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

Michael Yang's avatar
Michael Yang committed
707
	ctx, cancel := context.WithCancel(cmd.Context())
708
709
710
711
712
713
714
715
716
717
	defer cancel()

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

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

718
	var state *displayResponseState = &displayResponseState{}
719

720
	fn := func(response api.GenerateResponse) error {
Michael Yang's avatar
Michael Yang committed
721
		p.StopAndClear()
722

Patrick Devine's avatar
Patrick Devine committed
723
		latest = response
724
		content := response.Response
725

726
		displayResponse(content, opts.WordWrap, state)
727

Patrick Devine's avatar
Patrick Devine committed
728
729
		return nil
	}
730

731
732
733
734
735
736
737
	if opts.MultiModal {
		opts.Prompt, opts.Images, err = extractFileData(opts.Prompt)
		if err != nil {
			return err
		}
	}

Michael Yang's avatar
Michael Yang committed
738
739
740
741
	request := api.GenerateRequest{
		Model:    opts.Model,
		Prompt:   opts.Prompt,
		Context:  generateContext,
742
		Images:   opts.Images,
Michael Yang's avatar
Michael Yang committed
743
744
745
746
747
748
749
		Format:   opts.Format,
		System:   opts.System,
		Template: opts.Template,
		Options:  opts.Options,
	}

	if err := client.Generate(ctx, &request, fn); err != nil {
750
		if errors.Is(err, context.Canceled) {
751
			return nil
752
		}
753
		return err
Patrick Devine's avatar
Patrick Devine committed
754
	}
755

756
	if opts.Prompt != "" {
Michael Yang's avatar
Michael Yang committed
757
758
		fmt.Println()
		fmt.Println()
Patrick Devine's avatar
Patrick Devine committed
759
	}
760

761
762
763
764
	if !latest.Done {
		return nil
	}

Patrick Devine's avatar
Patrick Devine committed
765
766
	verbose, err := cmd.Flags().GetBool("verbose")
	if err != nil {
767
		return err
Patrick Devine's avatar
Patrick Devine committed
768
	}
Michael Yang's avatar
Michael Yang committed
769

Patrick Devine's avatar
Patrick Devine committed
770
771
	if verbose {
		latest.Summary()
Michael Yang's avatar
Michael Yang committed
772
	}
Michael Yang's avatar
Michael Yang committed
773

Patrick Devine's avatar
Patrick Devine committed
774
775
776
	ctx = context.WithValue(cmd.Context(), generateContextKey("context"), latest.Context)
	cmd.SetContext(ctx)

777
	return nil
Michael Yang's avatar
Michael Yang committed
778
779
}

780
func RunServer(cmd *cobra.Command, _ []string) error {
781
	host, port, err := net.SplitHostPort(strings.Trim(os.Getenv("OLLAMA_HOST"), "\"'"))
Michael Yang's avatar
Michael Yang committed
782
783
	if err != nil {
		host, port = "127.0.0.1", "11434"
Michael Yang's avatar
Michael Yang committed
784
		if ip := net.ParseIP(strings.Trim(os.Getenv("OLLAMA_HOST"), "[]")); ip != nil {
Michael Yang's avatar
Michael Yang committed
785
786
			host = ip.String()
		}
Jeffrey Morgan's avatar
Jeffrey Morgan committed
787
	}
788

Michael Yang's avatar
Michael Yang committed
789
	if err := initializeKeypair(); err != nil {
790
791
792
		return err
	}

Michael Yang's avatar
Michael Yang committed
793
	ln, err := net.Listen("tcp", net.JoinHostPort(host, port))
794
795
796
	if err != nil {
		return err
	}
Jeffrey Morgan's avatar
Jeffrey Morgan committed
797

798
	return server.Serve(ln)
Jeffrey Morgan's avatar
Jeffrey Morgan committed
799
800
}

801
802
803
804
805
806
807
808
809
810
811
812
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
813
		cryptoPublicKey, cryptoPrivateKey, err := ed25519.GenerateKey(rand.Reader)
814
815
816
817
		if err != nil {
			return err
		}

Michael Yang's avatar
Michael Yang committed
818
		privateKeyBytes, err := ssh.MarshalPrivateKey(cryptoPrivateKey, "")
819
820
821
822
		if err != nil {
			return err
		}

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

Michael Yang's avatar
Michael Yang committed
827
		if err := os.WriteFile(privKeyPath, pem.EncodeToMemory(privateKeyBytes), 0o600); err != nil {
828
829
830
			return err
		}

Michael Yang's avatar
Michael Yang committed
831
		sshPublicKey, err := ssh.NewPublicKey(cryptoPublicKey)
832
833
834
835
		if err != nil {
			return err
		}

Michael Yang's avatar
Michael Yang committed
836
		publicKeyBytes := ssh.MarshalAuthorizedKey(sshPublicKey)
837

Michael Yang's avatar
Michael Yang committed
838
		if err := os.WriteFile(pubKeyPath, publicKeyBytes, 0o644); err != nil {
839
840
841
			return err
		}

Michael Yang's avatar
Michael Yang committed
842
		fmt.Printf("Your new public key is: \n\n%s\n", publicKeyBytes)
843
844
845
846
	}
	return nil
}

847
848
//nolint:unused
func waitForServer(ctx context.Context, client *api.Client) error {
Bruce MacDonald's avatar
Bruce MacDonald committed
849
850
851
852
853
854
855
856
	// 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
857
			if err := client.Heartbeat(ctx); err == nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
858
859
860
861
				return nil // server has started
			}
		}
	}
862

Bruce MacDonald's avatar
Bruce MacDonald committed
863
864
}

Michael Yang's avatar
Michael Yang committed
865
func checkServerHeartbeat(cmd *cobra.Command, _ []string) error {
Michael Yang's avatar
Michael Yang committed
866
	client, err := api.ClientFromEnvironment()
867
868
869
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
870
	if err := client.Heartbeat(cmd.Context()); err != nil {
871
		if !strings.Contains(err.Error(), " refused") {
Bruce MacDonald's avatar
Bruce MacDonald committed
872
873
			return err
		}
874
875
		if err := startApp(cmd.Context(), client); err != nil {
			return fmt.Errorf("could not connect to ollama app, is it running?")
876
877
878
879
880
		}
	}
	return nil
}

Michael Yang's avatar
Michael Yang committed
881
882
883
884
885
886
887
888
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
889
890
891
892
893
		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
894
895
	}

896
	if serverVersion != version.Version {
Michael Yang's avatar
Michael Yang committed
897
		fmt.Printf("Warning: client version is %s\n", version.Version)
898
	}
Michael Yang's avatar
Michael Yang committed
899
900
}

901
902
903
904
905
906
907
908
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
909
910
func NewCLI() *cobra.Command {
	log.SetFlags(log.LstdFlags | log.Lshortfile)
Michael Yang's avatar
Michael Yang committed
911
	cobra.EnableCommandSorting = false
Jeffrey Morgan's avatar
Jeffrey Morgan committed
912

913
	if runtime.GOOS == "windows" {
914
		console.ConsoleFromFile(os.Stdin) //nolint:errcheck
915
916
	}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
917
	rootCmd := &cobra.Command{
918
919
920
921
		Use:           "ollama",
		Short:         "Large language model runner",
		SilenceUsage:  true,
		SilenceErrors: true,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
922
923
924
		CompletionOptions: cobra.CompletionOptions{
			DisableDefaultCmd: true,
		},
Michael Yang's avatar
Michael Yang committed
925
926
927
928
929
930
931
932
		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
933
934
	}

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

937
	createCmd := &cobra.Command{
938
939
		Use:     "create MODEL",
		Short:   "Create a model from a Modelfile",
Michael Yang's avatar
Michael Yang committed
940
		Args:    cobra.ExactArgs(1),
941
942
		PreRunE: checkServerHeartbeat,
		RunE:    CreateHandler,
943
944
945
946
	}

	createCmd.Flags().StringP("file", "f", "Modelfile", "Name of the Modelfile (default \"Modelfile\")")

Patrick Devine's avatar
Patrick Devine committed
947
948
949
	showCmd := &cobra.Command{
		Use:     "show MODEL",
		Short:   "Show information for a model",
Michael Yang's avatar
Michael Yang committed
950
		Args:    cobra.ExactArgs(1),
Patrick Devine's avatar
Patrick Devine committed
951
952
953
954
955
956
957
958
		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")
959
	showCmd.Flags().Bool("system", false, "Show system message of a model")
Patrick Devine's avatar
Patrick Devine committed
960

Jeffrey Morgan's avatar
Jeffrey Morgan committed
961
	runCmd := &cobra.Command{
962
963
964
965
		Use:   "run MODEL [PROMPT]",
		Short: "Run a model",
		Args:  cobra.MinimumNArgs(1),
		RunE:  RunHandler,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
966
967
	}

968
	runCmd.Flags().Bool("verbose", false, "Show timings for response")
969
	runCmd.Flags().Bool("insecure", false, "Use an insecure registry")
970
	runCmd.Flags().Bool("nowordwrap", false, "Don't wrap words to the next line automatically")
Jeffrey Morgan's avatar
Jeffrey Morgan committed
971
	runCmd.Flags().String("format", "", "Response format (e.g. json)")
Jeffrey Morgan's avatar
Jeffrey Morgan committed
972
973
974
975
	serveCmd := &cobra.Command{
		Use:     "serve",
		Aliases: []string{"start"},
		Short:   "Start ollama",
Michael Yang's avatar
Michael Yang committed
976
		Args:    cobra.ExactArgs(0),
Michael Yang's avatar
Michael Yang committed
977
		RunE:    RunServer,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
978
	}
979
980
981
	serveCmd.SetUsageTemplate(serveCmd.UsageTemplate() + `
Environment Variables:

982
983
984
985
    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")
986
    OLLAMA_DEBUG        Set to 1 to enable additional debug logging
987
`)
Jeffrey Morgan's avatar
Jeffrey Morgan committed
988

989
	pullCmd := &cobra.Command{
990
991
		Use:     "pull MODEL",
		Short:   "Pull a model from a registry",
Michael Yang's avatar
Michael Yang committed
992
		Args:    cobra.ExactArgs(1),
993
994
		PreRunE: checkServerHeartbeat,
		RunE:    PullHandler,
995
996
	}

997
998
	pullCmd.Flags().Bool("insecure", false, "Use an insecure registry")

999
	pushCmd := &cobra.Command{
1000
1001
		Use:     "push MODEL",
		Short:   "Push a model to a registry",
Michael Yang's avatar
Michael Yang committed
1002
		Args:    cobra.ExactArgs(1),
1003
1004
		PreRunE: checkServerHeartbeat,
		RunE:    PushHandler,
1005
1006
	}

1007
1008
	pushCmd.Flags().Bool("insecure", false, "Use an insecure registry")

Patrick Devine's avatar
Patrick Devine committed
1009
	listCmd := &cobra.Command{
1010
		Use:     "list",
Patrick Devine's avatar
Patrick Devine committed
1011
		Aliases: []string{"ls"},
1012
		Short:   "List models",
1013
		PreRunE: checkServerHeartbeat,
1014
		RunE:    ListHandler,
1015
	}
Patrick Devine's avatar
Patrick Devine committed
1016
	copyCmd := &cobra.Command{
Michael Yang's avatar
Michael Yang committed
1017
		Use:     "cp SOURCE TARGET",
1018
		Short:   "Copy a model",
Michael Yang's avatar
Michael Yang committed
1019
		Args:    cobra.ExactArgs(2),
1020
1021
		PreRunE: checkServerHeartbeat,
		RunE:    CopyHandler,
Patrick Devine's avatar
Patrick Devine committed
1022
1023
	}

1024
	deleteCmd := &cobra.Command{
Michael Yang's avatar
Michael Yang committed
1025
		Use:     "rm MODEL [MODEL...]",
1026
1027
1028
1029
		Short:   "Remove a model",
		Args:    cobra.MinimumNArgs(1),
		PreRunE: checkServerHeartbeat,
		RunE:    DeleteHandler,
Patrick Devine's avatar
Patrick Devine committed
1030
1031
	}

1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
	for _, cmd := range []*cobra.Command{
		createCmd,
		showCmd,
		runCmd,
		pullCmd,
		pushCmd,
		listCmd,
		copyCmd,
		deleteCmd,
	} {
		appendHostEnvDocs(cmd)
	}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1045
1046
	rootCmd.AddCommand(
		serveCmd,
1047
		createCmd,
Patrick Devine's avatar
Patrick Devine committed
1048
		showCmd,
1049
		runCmd,
1050
1051
		pullCmd,
		pushCmd,
Patrick Devine's avatar
Patrick Devine committed
1052
		listCmd,
Patrick Devine's avatar
Patrick Devine committed
1053
		copyCmd,
1054
		deleteCmd,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1055
1056
1057
1058
	)

	return rootCmd
}