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

import (
Michael Yang's avatar
Michael Yang committed
4
	"bytes"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
5
	"context"
6
7
	"crypto/ed25519"
	"crypto/rand"
Michael Yang's avatar
Michael Yang committed
8
	"crypto/sha256"
9
	"encoding/pem"
Michael Yang's avatar
Michael Yang committed
10
	"errors"
Bruce MacDonald's avatar
Bruce MacDonald committed
11
	"fmt"
Michael Yang's avatar
Michael Yang committed
12
	"io"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
13
14
	"log"
	"net"
15
	"net/http"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
16
	"os"
17
	"os/exec"
18
	"os/signal"
19
	"path/filepath"
Patrick Devine's avatar
Patrick Devine 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

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

Jeffrey Morgan's avatar
Jeffrey Morgan committed
32
	"github.com/jmorganca/ollama/api"
Patrick Devine's avatar
Patrick Devine committed
33
	"github.com/jmorganca/ollama/format"
Michael Yang's avatar
Michael Yang committed
34
	"github.com/jmorganca/ollama/parser"
Michael Yang's avatar
Michael Yang committed
35
	"github.com/jmorganca/ollama/progress"
Patrick Devine's avatar
Patrick Devine committed
36
	"github.com/jmorganca/ollama/readline"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
37
	"github.com/jmorganca/ollama/server"
Michael Yang's avatar
Michael Yang committed
38
	"github.com/jmorganca/ollama/version"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
39
40
)

Patrick Devine's avatar
Patrick Devine committed
41
42
type ImageData []byte

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

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

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

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

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

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

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

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

Michael Yang's avatar
Michael Yang committed
93
94
			bin, err := os.Open(path)
			if errors.Is(err, os.ErrNotExist) && c.Name == "model" {
Michael Yang's avatar
Michael Yang committed
95
				continue
Michael Yang's avatar
Michael Yang committed
96
97
98
99
100
101
102
103
104
105
106
107
			} else if err != nil {
				return err
			}
			defer bin.Close()

			hash := sha256.New()
			if _, err := io.Copy(hash, bin); err != nil {
				return err
			}
			bin.Seek(0, io.SeekStart)

			digest := fmt.Sprintf("sha256:%x", hash.Sum(nil))
Michael Yang's avatar
Michael Yang committed
108
			if err = client.CreateBlob(cmd.Context(), digest, bin); err != nil {
Michael Yang's avatar
Michael Yang committed
109
110
111
				return err
			}

Michael Yang's avatar
Michael Yang committed
112
			modelfile = bytes.ReplaceAll(modelfile, []byte(c.Args), []byte("@"+digest))
Michael Yang's avatar
Michael Yang committed
113
114
		}
	}
Michael Yang's avatar
Michael Yang committed
115

116
	fn := func(resp api.ProgressResponse) error {
Michael Yang's avatar
Michael Yang committed
117
118
119
120
121
		if resp.Digest != "" {
			spinner.Stop()

			bar, ok := bars[resp.Digest]
			if !ok {
122
				bar = progress.NewBar(fmt.Sprintf("pulling %s...", resp.Digest[7:19]), resp.Total, resp.Completed)
Michael Yang's avatar
Michael Yang committed
123
124
125
126
127
128
129
130
131
132
133
134
135
				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)
		}

136
137
138
		return nil
	}

139
	request := api.CreateRequest{Name: args[0], Modelfile: string(modelfile)}
Michael Yang's avatar
Michael Yang committed
140
	if err := client.Create(cmd.Context(), &request, fn); err != nil {
141
142
143
144
145
146
		return err
	}

	return nil
}

147
func RunHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
148
	client, err := api.ClientFromEnvironment()
149
150
151
152
	if err != nil {
		return err
	}

153
154
	name := args[0]
	// check if the model exists on the server
Michael Yang's avatar
Michael Yang committed
155
	_, err = client.Show(cmd.Context(), &api.ShowRequest{Name: name})
Michael Yang's avatar
Michael Yang committed
156
157
158
159
	var statusError api.StatusError
	switch {
	case errors.As(err, &statusError) && statusError.StatusCode == http.StatusNotFound:
		if err := PullHandler(cmd, args); err != nil {
160
			return err
Michael Yang's avatar
Michael Yang committed
161
		}
Michael Yang's avatar
Michael Yang committed
162
163
	case err != nil:
		return err
164
165
	}

166
	return RunGenerate(cmd, args)
Bruce MacDonald's avatar
Bruce MacDonald committed
167
168
}

169
func PushHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
170
	client, err := api.ClientFromEnvironment()
171
172
173
	if err != nil {
		return err
	}
174

175
176
177
178
179
	insecure, err := cmd.Flags().GetBool("insecure")
	if err != nil {
		return err
	}

Michael Yang's avatar
Michael Yang committed
180
181
182
183
	p := progress.NewProgress(os.Stderr)
	defer p.Stop()

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

187
	fn := func(resp api.ProgressResponse) error {
Michael Yang's avatar
Michael Yang committed
188
		if resp.Digest != "" {
189
190
191
			if spinner != nil {
				spinner.Stop()
			}
Michael Yang's avatar
Michael Yang committed
192
193
194

			bar, ok := bars[resp.Digest]
			if !ok {
195
				bar = progress.NewBar(fmt.Sprintf("pushing %s...", resp.Digest[7:19]), resp.Total, resp.Completed)
Michael Yang's avatar
Michael Yang committed
196
197
198
199
200
201
				bars[resp.Digest] = bar
				p.Add(resp.Digest, bar)
			}

			bar.Set(resp.Completed)
		} else if status != resp.Status {
202
203
204
			if spinner != nil {
				spinner.Stop()
			}
Michael Yang's avatar
Michael Yang committed
205
206
207
208
209
210

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

211
212
213
		return nil
	}

Michael Yang's avatar
Michael Yang committed
214
	request := api.PushRequest{Name: args[0], Insecure: insecure}
Michael Yang's avatar
Michael Yang committed
215
	if err := client.Push(cmd.Context(), &request, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
216
217
218
		return err
	}

219
	spinner.Stop()
Michael Yang's avatar
Michael Yang committed
220
	return nil
221
222
}

223
func ListHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
224
	client, err := api.ClientFromEnvironment()
225
226
227
	if err != nil {
		return err
	}
Patrick Devine's avatar
Patrick Devine committed
228

Michael Yang's avatar
Michael Yang committed
229
	models, err := client.List(cmd.Context())
Patrick Devine's avatar
Patrick Devine committed
230
231
232
233
234
235
236
	if err != nil {
		return err
	}

	var data [][]string

	for _, m := range models.Models {
Michael Yang's avatar
Michael Yang committed
237
		if len(args) == 0 || strings.HasPrefix(m.Name, args[0]) {
238
			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
239
		}
Patrick Devine's avatar
Patrick Devine committed
240
241
242
	}

	table := tablewriter.NewWriter(os.Stdout)
Patrick Devine's avatar
Patrick Devine committed
243
	table.SetHeader([]string{"NAME", "ID", "SIZE", "MODIFIED"})
Patrick Devine's avatar
Patrick Devine committed
244
245
246
247
248
249
250
251
252
253
254
255
	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
}

256
func DeleteHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
257
	client, err := api.ClientFromEnvironment()
258
259
260
	if err != nil {
		return err
	}
261

262
263
	for _, name := range args {
		req := api.DeleteRequest{Name: name}
Michael Yang's avatar
Michael Yang committed
264
		if err := client.Delete(cmd.Context(), &req); err != nil {
265
266
267
			return err
		}
		fmt.Printf("deleted '%s'\n", name)
268
269
270
271
	}
	return nil
}

Patrick Devine's avatar
Patrick Devine committed
272
func ShowHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
273
	client, err := api.ClientFromEnvironment()
Patrick Devine's avatar
Patrick Devine committed
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
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
	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 {
323
		return errors.New("only one of '--license', '--modelfile', '--parameters', '--system', or '--template' can be specified")
Patrick Devine's avatar
Patrick Devine committed
324
	} else if flagsSet == 0 {
325
		return errors.New("one of '--license', '--modelfile', '--parameters', '--system', or '--template' must be specified")
Patrick Devine's avatar
Patrick Devine committed
326
327
328
	}

	req := api.ShowRequest{Name: args[0]}
Michael Yang's avatar
Michael Yang committed
329
	resp, err := client.Show(cmd.Context(), &req)
Patrick Devine's avatar
Patrick Devine committed
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
	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
350
func CopyHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
351
	client, err := api.ClientFromEnvironment()
352
353
354
	if err != nil {
		return err
	}
Patrick Devine's avatar
Patrick Devine committed
355
356

	req := api.CopyRequest{Source: args[0], Destination: args[1]}
Michael Yang's avatar
Michael Yang committed
357
	if err := client.Copy(cmd.Context(), &req); err != nil {
Patrick Devine's avatar
Patrick Devine committed
358
359
360
361
362
363
		return err
	}
	fmt.Printf("copied '%s' to '%s'\n", args[0], args[1])
	return nil
}

364
func PullHandler(cmd *cobra.Command, args []string) error {
365
366
367
368
369
	insecure, err := cmd.Flags().GetBool("insecure")
	if err != nil {
		return err
	}

Michael Yang's avatar
Michael Yang committed
370
	client, err := api.ClientFromEnvironment()
371
372
373
	if err != nil {
		return err
	}
374

Michael Yang's avatar
Michael Yang committed
375
376
377
378
379
	p := progress.NewProgress(os.Stderr)
	defer p.Stop()

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

380
381
	var status string
	var spinner *progress.Spinner
Michael Yang's avatar
Michael Yang committed
382

383
	fn := func(resp api.ProgressResponse) error {
Michael Yang's avatar
Michael Yang committed
384
		if resp.Digest != "" {
385
386
387
			if spinner != nil {
				spinner.Stop()
			}
Michael Yang's avatar
Michael Yang committed
388
389
390

			bar, ok := bars[resp.Digest]
			if !ok {
391
				bar = progress.NewBar(fmt.Sprintf("pulling %s...", resp.Digest[7:19]), resp.Total, resp.Completed)
Michael Yang's avatar
Michael Yang committed
392
393
394
395
396
397
				bars[resp.Digest] = bar
				p.Add(resp.Digest, bar)
			}

			bar.Set(resp.Completed)
		} else if status != resp.Status {
398
399
400
			if spinner != nil {
				spinner.Stop()
			}
Michael Yang's avatar
Michael Yang committed
401
402
403
404
405
406

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

407
408
		return nil
	}
409

Michael Yang's avatar
Michael Yang committed
410
	request := api.PullRequest{Name: args[0], Insecure: insecure}
Michael Yang's avatar
Michael Yang committed
411
	if err := client.Pull(cmd.Context(), &request, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
412
413
414
415
		return err
	}

	return nil
Michael Yang's avatar
Michael Yang committed
416
417
}

418
419
420
421
422
423
424
func RunGenerate(cmd *cobra.Command, args []string) error {
	interactive := true

	opts := generateOptions{
		Model:    args[0],
		WordWrap: os.Getenv("TERM") == "xterm-256color",
		Options:  map[string]interface{}{},
Patrick Devine's avatar
Patrick Devine committed
425
		Images:   []ImageData{},
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
461
462
463
464
465
466
	}

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

type generateContextKey string

type generateOptions struct {
467
	Model    string
468
	Prompt   string
469
470
	WordWrap bool
	Format   string
471
	System   string
472
	Template string
Patrick Devine's avatar
Patrick Devine committed
473
	Images   []ImageData
474
475
476
	Options  map[string]interface{}
}

477
func generate(cmd *cobra.Command, opts generateOptions) error {
Michael Yang's avatar
Michael Yang committed
478
	client, err := api.ClientFromEnvironment()
Patrick Devine's avatar
Patrick Devine committed
479
	if err != nil {
480
		return err
Patrick Devine's avatar
Patrick Devine committed
481
	}
Michael Yang's avatar
Michael Yang committed
482

Michael Yang's avatar
Michael Yang committed
483
	p := progress.NewProgress(os.Stderr)
484
	defer p.StopAndClear()
485

Michael Yang's avatar
Michael Yang committed
486
487
488
	spinner := progress.NewSpinner("")
	p.Add("", spinner)

489
490
491
492
493
494
495
	var latest api.GenerateResponse

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

496
	termWidth, _, err := term.GetSize(int(os.Stdout.Fd()))
497
	if err != nil {
498
		opts.WordWrap = false
499
500
	}

Michael Yang's avatar
Michael Yang committed
501
	ctx, cancel := context.WithCancel(cmd.Context())
502
503
504
505
506
507
508
509
510
511
	defer cancel()

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

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

512
513
514
	var currentLineLength int
	var wordBuffer string

515
	fn := func(response api.GenerateResponse) error {
Michael Yang's avatar
Michael Yang committed
516
		p.StopAndClear()
517

Patrick Devine's avatar
Patrick Devine committed
518
		latest = response
519

520
521
		termWidth, _, _ = term.GetSize(int(os.Stdout.Fd()))
		if opts.WordWrap && termWidth >= 10 {
522
			for _, ch := range response.Response {
523
				if currentLineLength+1 > termWidth-5 {
524
525
526
527
528
529
530
					if len(wordBuffer) > termWidth-10 {
						fmt.Printf("%s%c", wordBuffer, ch)
						wordBuffer = ""
						currentLineLength = 0
						continue
					}

531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
					// backtrack the length of the last word and clear to the end of the line
					fmt.Printf("\x1b[%dD\x1b[K\n", len(wordBuffer))
					fmt.Printf("%s%c", wordBuffer, ch)
					currentLineLength = len(wordBuffer) + 1
				} else {
					fmt.Print(string(ch))
					currentLineLength += 1

					switch ch {
					case ' ':
						wordBuffer = ""
					case '\n':
						currentLineLength = 0
					default:
						wordBuffer += string(ch)
					}
				}
			}
		} else {
550
			fmt.Printf("%s%s", wordBuffer, response.Response)
551
552
553
			if len(wordBuffer) > 0 {
				wordBuffer = ""
			}
554
555
		}

Patrick Devine's avatar
Patrick Devine committed
556
557
		return nil
	}
558

Patrick Devine's avatar
Patrick Devine committed
559
560
561
562
	images := make([]api.ImageData, 0)
	for _, i := range opts.Images {
		images = append(images, api.ImageData(i))
	}
Michael Yang's avatar
Michael Yang committed
563
564
565
566
567
568
569
570
	request := api.GenerateRequest{
		Model:    opts.Model,
		Prompt:   opts.Prompt,
		Context:  generateContext,
		Format:   opts.Format,
		System:   opts.System,
		Template: opts.Template,
		Options:  opts.Options,
Patrick Devine's avatar
Patrick Devine committed
571
		Images:   images,
Michael Yang's avatar
Michael Yang committed
572
573
574
	}

	if err := client.Generate(ctx, &request, fn); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
575
576
		switch {
		case errors.Is(err, context.Canceled):
577
			return nil
Bruce MacDonald's avatar
Bruce MacDonald committed
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
		case strings.Contains(err.Error(), "unsupported model format"):
			// pull and retry to see if the model has been updated
			parts := strings.Split(opts.Model, string(os.PathSeparator))
			if len(parts) == 1 {
				// this is a library model, log some info
				fmt.Fprintln(os.Stderr, "This model is no longer compatible with Ollama. Pulling a new version...")
			}
			if err := PullHandler(cmd, []string{opts.Model}); err != nil {
				fmt.Printf("Error: %s\n", err)
				return fmt.Errorf("unsupported model, please update this model to gguf format") // relay the original error
			}
			// retry
			if err := client.Generate(ctx, &request, fn); err != nil {
				if errors.Is(err, context.Canceled) {
					return nil
				}
				return err
			}
		default:
			return err
598
		}
Patrick Devine's avatar
Patrick Devine committed
599
	}
600
	if opts.Prompt != "" {
Michael Yang's avatar
Michael Yang committed
601
602
		fmt.Println()
		fmt.Println()
Patrick Devine's avatar
Patrick Devine committed
603
	}
604

605
606
607
608
	if !latest.Done {
		return nil
	}

Patrick Devine's avatar
Patrick Devine committed
609
610
	verbose, err := cmd.Flags().GetBool("verbose")
	if err != nil {
611
		return err
Patrick Devine's avatar
Patrick Devine committed
612
	}
Michael Yang's avatar
Michael Yang committed
613

Patrick Devine's avatar
Patrick Devine committed
614
615
	if verbose {
		latest.Summary()
Michael Yang's avatar
Michael Yang committed
616
	}
Michael Yang's avatar
Michael Yang committed
617

Patrick Devine's avatar
Patrick Devine committed
618
619
620
	ctx = context.WithValue(cmd.Context(), generateContextKey("context"), latest.Context)
	cmd.SetContext(ctx)

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

624
625
626
627
628
629
630
631
632
type MultilineState int

const (
	MultilineNone MultilineState = iota
	MultilinePrompt
	MultilineSystem
	MultilineTemplate
)

Patrick Devine's avatar
Patrick Devine committed
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
func modelIsMultiModal(cmd *cobra.Command, name string) bool {
	// get model details
	client, err := api.ClientFromEnvironment()
	if err != nil {
		fmt.Println("error: couldn't connect to ollama server")
		return false
	}

	req := api.ShowRequest{Name: name}
	resp, err := client.Show(cmd.Context(), &req)
	if err != nil {
		return false
	}

	return slices.Contains(resp.Details.Families, "clip")
}

650
func generateInteractive(cmd *cobra.Command, opts generateOptions) error {
Patrick Devine's avatar
Patrick Devine committed
651
652
	multiModal := modelIsMultiModal(cmd, opts.Model)

Patrick Devine's avatar
Patrick Devine committed
653
	// load the model
654
655
656
	loadOpts := generateOptions{
		Model:  opts.Model,
		Prompt: "",
Patrick Devine's avatar
Patrick Devine committed
657
		Images: []ImageData{},
658
659
	}
	if err := generate(cmd, loadOpts); err != nil {
Patrick Devine's avatar
Patrick Devine committed
660
661
662
		return err
	}

Michael Yang's avatar
Michael Yang committed
663
	usage := func() {
Patrick Devine's avatar
Patrick Devine committed
664
665
666
667
668
669
670
671
672
673
674
675
		fmt.Fprintln(os.Stderr, "Available Commands:")
		fmt.Fprintln(os.Stderr, "  /set         Set session variables")
		fmt.Fprintln(os.Stderr, "  /show        Show model information")
		fmt.Fprintln(os.Stderr, "  /bye         Exit")
		fmt.Fprintln(os.Stderr, "  /?, /help    Help for a command")
		fmt.Fprintln(os.Stderr, "")
		fmt.Fprintln(os.Stderr, "Use \"\"\" to begin a multi-line message.")
		fmt.Fprintln(os.Stderr, "")
	}

	usageSet := func() {
		fmt.Fprintln(os.Stderr, "Available Commands:")
676
		fmt.Fprintln(os.Stderr, "  /set parameter ...     Set a parameter")
677
		fmt.Fprintln(os.Stderr, "  /set system <string>   Set system message")
678
679
680
681
682
683
684
685
686
		fmt.Fprintln(os.Stderr, "  /set template <string> Set prompt template")
		fmt.Fprintln(os.Stderr, "  /set history           Enable history")
		fmt.Fprintln(os.Stderr, "  /set nohistory         Disable history")
		fmt.Fprintln(os.Stderr, "  /set wordwrap          Enable wordwrap")
		fmt.Fprintln(os.Stderr, "  /set nowordwrap        Disable wordwrap")
		fmt.Fprintln(os.Stderr, "  /set format json       Enable JSON mode")
		fmt.Fprintln(os.Stderr, "  /set noformat          Disable formatting")
		fmt.Fprintln(os.Stderr, "  /set verbose           Show LLM stats")
		fmt.Fprintln(os.Stderr, "  /set quiet             Disable LLM stats")
Patrick Devine's avatar
Patrick Devine committed
687
688
689
690
691
692
693
694
		fmt.Fprintln(os.Stderr, "")
	}

	usageShow := func() {
		fmt.Fprintln(os.Stderr, "Available Commands:")
		fmt.Fprintln(os.Stderr, "  /show license      Show model license")
		fmt.Fprintln(os.Stderr, "  /show modelfile    Show Modelfile for this model")
		fmt.Fprintln(os.Stderr, "  /show parameters   Show parameters for this model")
695
		fmt.Fprintln(os.Stderr, "  /show system       Show system message")
Patrick Devine's avatar
Patrick Devine committed
696
697
		fmt.Fprintln(os.Stderr, "  /show template     Show prompt template")
		fmt.Fprintln(os.Stderr, "")
Michael Yang's avatar
Michael Yang committed
698
699
	}

700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
	// only list out the most common parameters
	usageParameters := func() {
		fmt.Fprintln(os.Stderr, "Available Parameters:")
		fmt.Fprintln(os.Stderr, "  /set parameter seed <int>             Random number seed")
		fmt.Fprintln(os.Stderr, "  /set parameter num_predict <int>      Max number of tokens to predict")
		fmt.Fprintln(os.Stderr, "  /set parameter top_k <int>            Pick from top k num of tokens")
		fmt.Fprintln(os.Stderr, "  /set parameter top_p <float>          Pick token based on sum of probabilities")
		fmt.Fprintln(os.Stderr, "  /set parameter num_ctx <int>          Set the context size")
		fmt.Fprintln(os.Stderr, "  /set parameter temperature <float>    Set creativity level")
		fmt.Fprintln(os.Stderr, "  /set parameter repeat_penalty <float> How strongly to penalize repetitions")
		fmt.Fprintln(os.Stderr, "  /set parameter repeat_last_n <int>    Set how far back to look for repetitions")
		fmt.Fprintln(os.Stderr, "  /set parameter num_gpu <int>          The number of layers to send to the GPU")
		fmt.Fprintln(os.Stderr, "  /set parameter stop \"<string>\", ...   Set the stop parameters")
		fmt.Fprintln(os.Stderr, "")
	}

716
	scanner, err := readline.New(readline.Prompt{
Patrick Devine's avatar
Patrick Devine committed
717
718
719
720
		Prompt:         ">>> ",
		AltPrompt:      "... ",
		Placeholder:    "Send a message (/? for help)",
		AltPlaceholder: `Use """ to end multi-line input`,
721
	})
Michael Yang's avatar
Michael Yang committed
722
723
724
725
	if err != nil {
		return err
	}

726
727
728
	fmt.Print(readline.StartBracketedPaste)
	defer fmt.Printf(readline.EndBracketedPaste)

729
	var multiline MultilineState
730
	var prompt string
731

Michael Yang's avatar
Michael Yang committed
732
733
734
735
	for {
		line, err := scanner.Readline()
		switch {
		case errors.Is(err, io.EOF):
736
			fmt.Println()
Michael Yang's avatar
Michael Yang committed
737
738
			return nil
		case errors.Is(err, readline.ErrInterrupt):
739
			if line == "" {
Patrick Devine's avatar
Patrick Devine committed
740
				fmt.Println("\nUse Ctrl-D or /bye to exit.")
741
742
			}

743
			scanner.Prompt.UseAlt = false
744
			prompt = ""
745

Michael Yang's avatar
Michael Yang committed
746
747
			continue
		case err != nil:
Michael Yang's avatar
Michael Yang committed
748
749
750
			return err
		}

Michael Yang's avatar
Michael Yang committed
751
		switch {
752
		case strings.HasPrefix(prompt, `"""`):
753
754
755
			// if the prompt so far starts with """ then we're in multiline mode
			// and we need to keep reading until we find a line that ends with """
			cut, found := strings.CutSuffix(line, `"""`)
756
			prompt += cut
757
758

			if !found {
759
				prompt += "\n"
760
761
				continue
			}
762

763
			prompt = strings.TrimPrefix(prompt, `"""`)
764
			scanner.Prompt.UseAlt = false
765
766
767

			switch multiline {
			case MultilineSystem:
768
769
				opts.System = prompt
				prompt = ""
770
				fmt.Println("Set system message.")
771
			case MultilineTemplate:
772
773
				opts.Template = prompt
				prompt = ""
774
				fmt.Println("Set prompt template.")
775
776
			}
			multiline = MultilineNone
777
		case strings.HasPrefix(line, `"""`) && len(prompt) == 0:
Patrick Devine's avatar
Patrick Devine committed
778
			scanner.Prompt.UseAlt = true
779
			multiline = MultilinePrompt
780
			prompt += line + "\n"
781
782
			continue
		case scanner.Pasting:
783
			prompt += line + "\n"
784
			continue
Michael Yang's avatar
Michael Yang committed
785
786
		case strings.HasPrefix(line, "/list"):
			args := strings.Fields(line)
787
			if err := ListHandler(cmd, args[1:]); err != nil {
Michael Yang's avatar
Michael Yang committed
788
789
790
791
792
793
794
795
796
797
				return err
			}
		case strings.HasPrefix(line, "/set"):
			args := strings.Fields(line)
			if len(args) > 1 {
				switch args[1] {
				case "history":
					scanner.HistoryEnable()
				case "nohistory":
					scanner.HistoryDisable()
798
				case "wordwrap":
799
					opts.WordWrap = true
800
801
					fmt.Println("Set 'wordwrap' mode.")
				case "nowordwrap":
802
					opts.WordWrap = false
803
					fmt.Println("Set 'nowordwrap' mode.")
Michael Yang's avatar
Michael Yang committed
804
805
				case "verbose":
					cmd.Flags().Set("verbose", "true")
806
					fmt.Println("Set 'verbose' mode.")
Michael Yang's avatar
Michael Yang committed
807
808
				case "quiet":
					cmd.Flags().Set("verbose", "false")
809
					fmt.Println("Set 'quiet' mode.")
Jeffrey Morgan's avatar
Jeffrey Morgan committed
810
811
812
813
				case "format":
					if len(args) < 3 || args[2] != "json" {
						fmt.Println("Invalid or missing format. For 'json' mode use '/set format json'")
					} else {
814
						opts.Format = args[2]
Jeffrey Morgan's avatar
Jeffrey Morgan committed
815
816
817
						fmt.Printf("Set format to '%s' mode.\n", args[2])
					}
				case "noformat":
818
					opts.Format = ""
Jeffrey Morgan's avatar
Jeffrey Morgan committed
819
					fmt.Println("Disabled format.")
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
				case "parameter":
					if len(args) < 4 {
						usageParameters()
						continue
					}
					var params []string
					for _, p := range args[3:] {
						params = append(params, p)
					}
					fp, err := api.FormatParams(map[string][]string{args[2]: params})
					if err != nil {
						fmt.Printf("Couldn't set parameter: %q\n\n", err)
						continue
					}
					fmt.Printf("Set parameter '%s' to '%s'\n\n", args[2], strings.Join(params, ", "))
					opts.Options[args[2]] = fp[args[2]]
836
837
838
839
840
841
842
843
844
				case "system", "template":
					if len(args) < 3 {
						usageSet()
						continue
					}
					line := strings.Join(args[2:], " ")
					line = strings.TrimPrefix(line, `"""`)
					if strings.HasPrefix(args[2], `"""`) {
						cut, found := strings.CutSuffix(line, `"""`)
845
						prompt += cut
846
847
						if found {
							if args[1] == "system" {
848
849
								opts.System = prompt
								fmt.Println("Set system message.")
850
							} else {
851
								opts.Template = prompt
Michael Yang's avatar
Michael Yang committed
852
								fmt.Println("Set prompt template.")
853
							}
854
							prompt = ""
855
						} else {
856
							prompt = `"""` + prompt + "\n"
857
858
859
860
861
862
863
864
							if args[1] == "system" {
								multiline = MultilineSystem
							} else {
								multiline = MultilineTemplate
							}
							scanner.Prompt.UseAlt = true
						}
					} else {
865
						opts.System = line
866
						fmt.Println("Set system message.")
867
					}
868
869
				default:
					fmt.Printf("Unknown command '/set %s'. Type /? for help\n", args[1])
870
871
				}
			} else {
Patrick Devine's avatar
Patrick Devine committed
872
				usageSet()
873
874
875
876
			}
		case strings.HasPrefix(line, "/show"):
			args := strings.Fields(line)
			if len(args) > 1 {
877
878
879
880
881
				client, err := api.ClientFromEnvironment()
				if err != nil {
					fmt.Println("error: couldn't connect to ollama server")
					return err
				}
882
				resp, err := client.Show(cmd.Context(), &api.ShowRequest{Name: opts.Model})
883
				if err != nil {
Patrick Devine's avatar
Patrick Devine committed
884
					fmt.Println("error: couldn't get model")
885
					return err
886
				}
Patrick Devine's avatar
Patrick Devine committed
887

888
889
				switch args[1] {
				case "license":
890
					if resp.License == "" {
891
						fmt.Print("No license was specified for this model.\n\n")
892
893
894
					} else {
						fmt.Println(resp.License)
					}
Patrick Devine's avatar
Patrick Devine committed
895
896
897
				case "modelfile":
					fmt.Println(resp.Modelfile)
				case "parameters":
898
					if resp.Parameters == "" {
899
						fmt.Print("No parameters were specified for this model.\n\n")
900
					} else {
901
902
903
904
905
906
907
908
						if len(opts.Options) > 0 {
							fmt.Println("User defined parameters:")
							for k, v := range opts.Options {
								fmt.Printf("%-*s %v\n", 30, k, v)
							}
							fmt.Println()
						}
						fmt.Println("Model defined parameters:")
909
910
						fmt.Println(resp.Parameters)
					}
911
				case "system":
912
					switch {
913
914
					case opts.System != "":
						fmt.Println(opts.System + "\n")
915
916
917
					case resp.System != "":
						fmt.Println(resp.System + "\n")
					default:
918
						fmt.Print("No system message was specified for this model.\n\n")
919
					}
920
				case "template":
921
922
923
924
					switch {
					case opts.Template != "":
						fmt.Println(opts.Template + "\n")
					case resp.Template != "":
925
						fmt.Println(resp.Template)
926
927
					default:
						fmt.Print("No prompt template was specified for this model.\n\n")
928
					}
929
				default:
930
					fmt.Printf("Unknown command '/show %s'. Type /? for help\n", args[1])
Michael Yang's avatar
Michael Yang committed
931
				}
Patrick Devine's avatar
Patrick Devine committed
932
933
934
935
936
937
938
939
940
941
942
943
			} else {
				usageShow()
			}
		case strings.HasPrefix(line, "/help"), strings.HasPrefix(line, "/?"):
			args := strings.Fields(line)
			if len(args) > 1 {
				switch args[1] {
				case "set", "/set":
					usageSet()
				case "show", "/show":
					usageShow()
				}
944
945
			} else {
				usage()
Michael Yang's avatar
Michael Yang committed
946
947
948
			}
		case line == "/exit", line == "/bye":
			return nil
949
950
		case strings.HasPrefix(line, "/"):
			args := strings.Fields(line)
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
			isFile := false

			if multiModal {
				for _, f := range extractFileNames(line) {
					if strings.HasPrefix(f, args[0]) {
						isFile = true
						break
					}
				}
			}

			if isFile {
				prompt += line
			} else {
				fmt.Printf("Unknown command '%s'. Type /? for help\n", args[0])
				continue
			}
968
		default:
969
			prompt += line
Michael Yang's avatar
Michael Yang committed
970
971
		}

972
973
		if len(prompt) > 0 && multiline == MultilineNone {
			opts.Prompt = prompt
Patrick Devine's avatar
Patrick Devine committed
974
			if multiModal {
975
				newPrompt, images, err := extractFileData(prompt)
Patrick Devine's avatar
Patrick Devine committed
976
977
978
979
980
981
982
983
984
985
986
987
988
				if err != nil {
					return err
				}
				opts.Prompt = newPrompt

				// reset the context if we find another image
				if len(images) > 0 {
					opts.Images = images
					ctx := cmd.Context()
					ctx = context.WithValue(ctx, generateContextKey("context"), []int{})
					cmd.SetContext(ctx)
				}
				if len(opts.Images) == 0 {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
989
990
					fmt.Println("This model requires you to add a jpeg, png, or svg image.")
					fmt.Println()
Patrick Devine's avatar
Patrick Devine committed
991
992
993
994
					prompt = ""
					continue
				}
			}
995
			if err := generate(cmd, opts); err != nil {
Patrick Devine's avatar
Patrick Devine committed
996
997
				return err
			}
998

999
			prompt = ""
Michael Yang's avatar
Michael Yang committed
1000
1001
		}
	}
Bruce MacDonald's avatar
Bruce MacDonald committed
1002
1003
}

Patrick Devine's avatar
Patrick Devine committed
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
func normalizeFilePath(fp string) string {
	// Define a map of escaped characters and their replacements
	replacements := map[string]string{
		"\\ ":  " ",  // Escaped space
		"\\(":  "(",  // Escaped left parenthesis
		"\\)":  ")",  // Escaped right parenthesis
		"\\[":  "[",  // Escaped left square bracket
		"\\]":  "]",  // Escaped right square bracket
		"\\{":  "{",  // Escaped left curly brace
		"\\}":  "}",  // Escaped right curly brace
		"\\$":  "$",  // Escaped dollar sign
		"\\&":  "&",  // Escaped ampersand
		"\\;":  ";",  // Escaped semicolon
		"\\'":  "'",  // Escaped single quote
		"\\\\": "\\", // Escaped backslash
		"\\*":  "*",  // Escaped asterisk
		"\\?":  "?",  // Escaped question mark
	}

	for escaped, actual := range replacements {
		fp = strings.ReplaceAll(fp, escaped, actual)
	}
	return fp
}

1029
func extractFileNames(input string) []string {
Patrick Devine's avatar
Patrick Devine committed
1030
1031
1032
1033
1034
	// Regex to match file paths starting with / or ./ and include escaped spaces (\ or %20)
	// and followed by more characters and a file extension
	regexPattern := `(?:\./|/)[\S\\ ]+?\.(?i:jpg|jpeg|png|svg)\b`
	re := regexp.MustCompile(regexPattern)

1035
1036
1037
1038
1039
	return re.FindAllString(input, -1)
}

func extractFileData(input string) (string, []ImageData, error) {
	filePaths := extractFileNames(input)
Patrick Devine's avatar
Patrick Devine committed
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
	var imgs []ImageData

	for _, fp := range filePaths {
		nfp := normalizeFilePath(fp)
		data, err := getImageData(nfp)
		if err != nil {
			if os.IsNotExist(err) {
				continue
			}
			fmt.Printf("Couldn't process image: %q\n", err)
			return "", imgs, err
		}
		fmt.Printf("Added image '%s'\n", nfp)
		input = strings.ReplaceAll(input, fp, "")
		imgs = append(imgs, data)
	}
	return input, imgs, nil
}

1059
func RunServer(cmd *cobra.Command, _ []string) error {
Michael Yang's avatar
Michael Yang committed
1060
1061
1062
	host, port, err := net.SplitHostPort(os.Getenv("OLLAMA_HOST"))
	if err != nil {
		host, port = "127.0.0.1", "11434"
Michael Yang's avatar
Michael Yang committed
1063
		if ip := net.ParseIP(strings.Trim(os.Getenv("OLLAMA_HOST"), "[]")); ip != nil {
Michael Yang's avatar
Michael Yang committed
1064
1065
			host = ip.String()
		}
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1066
	}
1067

Michael Yang's avatar
Michael Yang committed
1068
	if err := initializeKeypair(); err != nil {
1069
1070
1071
		return err
	}

Michael Yang's avatar
Michael Yang committed
1072
	ln, err := net.Listen("tcp", net.JoinHostPort(host, port))
1073
1074
1075
	if err != nil {
		return err
	}
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1076

1077
	return server.Serve(ln)
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1078
1079
}

Patrick Devine's avatar
Patrick Devine committed
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
func getImageData(filePath string) ([]byte, error) {
	file, err := os.Open(filePath)
	if err != nil {
		return nil, err
	}
	defer file.Close()

	buf := make([]byte, 512)
	_, err = file.Read(buf)
	if err != nil {
		return nil, err
	}

	contentType := http.DetectContentType(buf)
	allowedTypes := []string{"image/jpeg", "image/jpg", "image/svg+xml", "image/png"}
	if !slices.Contains(allowedTypes, contentType) {
		return nil, fmt.Errorf("invalid image type: %s", contentType)
	}

	info, err := file.Stat()
	if err != nil {
		return nil, err
	}

	// Check if the file size exceeds 100MB
	var maxSize int64 = 100 * 1024 * 1024 // 100MB in bytes
	if info.Size() > maxSize {
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1107
		return nil, fmt.Errorf("file size exceeds maximum limit (100MB)")
Patrick Devine's avatar
Patrick Devine committed
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
	}

	buf = make([]byte, info.Size())
	_, err = file.Seek(0, 0)
	if err != nil {
		return nil, err
	}

	_, err = io.ReadFull(file, buf)
	if err != nil {
		return nil, err
	}

	return buf, nil
}

1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
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)
		_, privKey, err := ed25519.GenerateKey(rand.Reader)
		if err != nil {
			return err
		}

		privKeyBytes, err := format.OpenSSHPrivateKey(privKey, "")
		if err != nil {
			return err
		}

Michael Yang's avatar
Michael Yang committed
1146
		err = os.MkdirAll(filepath.Dir(privKeyPath), 0o755)
1147
1148
1149
1150
		if err != nil {
			return fmt.Errorf("could not create directory %w", err)
		}

1151
		err = os.WriteFile(privKeyPath, pem.EncodeToMemory(privKeyBytes), 0o600)
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
		if err != nil {
			return err
		}

		sshPrivateKey, err := ssh.NewSignerFromKey(privKey)
		if err != nil {
			return err
		}

		pubKeyData := ssh.MarshalAuthorizedKey(sshPrivateKey.PublicKey())

1163
		err = os.WriteFile(pubKeyPath, pubKeyData, 0o644)
1164
1165
1166
1167
1168
1169
1170
1171
1172
		if err != nil {
			return err
		}

		fmt.Printf("Your new public key is: \n\n%s\n", string(pubKeyData))
	}
	return nil
}

Michael Yang's avatar
Michael Yang committed
1173
func startMacApp(ctx context.Context, client *api.Client) error {
Bruce MacDonald's avatar
Bruce MacDonald committed
1174
1175
1176
1177
1178
	exe, err := os.Executable()
	if err != nil {
		return err
	}
	link, err := os.Readlink(exe)
Bruce MacDonald's avatar
Bruce MacDonald committed
1179
1180
1181
	if err != nil {
		return err
	}
Bruce MacDonald's avatar
Bruce MacDonald committed
1182
1183
1184
	if !strings.Contains(link, "Ollama.app") {
		return fmt.Errorf("could not find ollama app")
	}
Bruce MacDonald's avatar
Bruce MacDonald committed
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
	path := strings.Split(link, "Ollama.app")
	if err := exec.Command("/usr/bin/open", "-a", path[0]+"Ollama.app").Run(); err != nil {
		return err
	}
	// 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
1197
			if err := client.Heartbeat(ctx); err == nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1198
1199
1200
1201
1202
1203
				return nil // server has started
			}
		}
	}
}

Michael Yang's avatar
Michael Yang committed
1204
func checkServerHeartbeat(cmd *cobra.Command, _ []string) error {
Michael Yang's avatar
Michael Yang committed
1205
	client, err := api.ClientFromEnvironment()
1206
1207
1208
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
1209
	if err := client.Heartbeat(cmd.Context()); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1210
1211
1212
1213
		if !strings.Contains(err.Error(), "connection refused") {
			return err
		}
		if runtime.GOOS == "darwin" {
Michael Yang's avatar
Michael Yang committed
1214
			if err := startMacApp(cmd.Context(), client); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1215
				return fmt.Errorf("could not connect to ollama app, is it running?")
1216
			}
Bruce MacDonald's avatar
Bruce MacDonald committed
1217
		} else {
1218
1219
1220
1221
1222
1223
			return fmt.Errorf("could not connect to ollama server, run 'ollama serve' to start it")
		}
	}
	return nil
}

Michael Yang's avatar
Michael Yang committed
1224
1225
1226
1227
1228
1229
1230
1231
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
1232
1233
1234
1235
1236
		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
1237
1238
	}

1239
	if serverVersion != version.Version {
Michael Yang's avatar
Michael Yang committed
1240
		fmt.Printf("Warning: client version is %s\n", version.Version)
1241
	}
Michael Yang's avatar
Michael Yang committed
1242
1243
}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1244
1245
func NewCLI() *cobra.Command {
	log.SetFlags(log.LstdFlags | log.Lshortfile)
Michael Yang's avatar
Michael Yang committed
1246
	cobra.EnableCommandSorting = false
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1247
1248

	rootCmd := &cobra.Command{
1249
1250
1251
1252
		Use:           "ollama",
		Short:         "Large language model runner",
		SilenceUsage:  true,
		SilenceErrors: true,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1253
1254
1255
		CompletionOptions: cobra.CompletionOptions{
			DisableDefaultCmd: true,
		},
Michael Yang's avatar
Michael Yang committed
1256
1257
1258
1259
1260
1261
1262
1263
		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
1264
1265
	}

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

1268
	createCmd := &cobra.Command{
1269
1270
		Use:     "create MODEL",
		Short:   "Create a model from a Modelfile",
Michael Yang's avatar
Michael Yang committed
1271
		Args:    cobra.ExactArgs(1),
1272
1273
		PreRunE: checkServerHeartbeat,
		RunE:    CreateHandler,
1274
1275
1276
1277
	}

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

Patrick Devine's avatar
Patrick Devine committed
1278
1279
1280
	showCmd := &cobra.Command{
		Use:     "show MODEL",
		Short:   "Show information for a model",
Michael Yang's avatar
Michael Yang committed
1281
		Args:    cobra.ExactArgs(1),
Patrick Devine's avatar
Patrick Devine committed
1282
1283
1284
1285
1286
1287
1288
1289
		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")
1290
	showCmd.Flags().Bool("system", false, "Show system message of a model")
Patrick Devine's avatar
Patrick Devine committed
1291

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1292
	runCmd := &cobra.Command{
1293
1294
1295
1296
1297
		Use:     "run MODEL [PROMPT]",
		Short:   "Run a model",
		Args:    cobra.MinimumNArgs(1),
		PreRunE: checkServerHeartbeat,
		RunE:    RunHandler,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1298
1299
	}

1300
	runCmd.Flags().Bool("verbose", false, "Show timings for response")
1301
	runCmd.Flags().Bool("insecure", false, "Use an insecure registry")
1302
	runCmd.Flags().Bool("nowordwrap", false, "Don't wrap words to the next line automatically")
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1303
	runCmd.Flags().String("format", "", "Response format (e.g. json)")
1304

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1305
1306
1307
1308
	serveCmd := &cobra.Command{
		Use:     "serve",
		Aliases: []string{"start"},
		Short:   "Start ollama",
Michael Yang's avatar
Michael Yang committed
1309
		Args:    cobra.ExactArgs(0),
Michael Yang's avatar
Michael Yang committed
1310
		RunE:    RunServer,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1311
1312
	}

1313
	pullCmd := &cobra.Command{
1314
1315
		Use:     "pull MODEL",
		Short:   "Pull a model from a registry",
Michael Yang's avatar
Michael Yang committed
1316
		Args:    cobra.ExactArgs(1),
1317
1318
		PreRunE: checkServerHeartbeat,
		RunE:    PullHandler,
1319
1320
	}

1321
1322
	pullCmd.Flags().Bool("insecure", false, "Use an insecure registry")

1323
	pushCmd := &cobra.Command{
1324
1325
		Use:     "push MODEL",
		Short:   "Push a model to a registry",
Michael Yang's avatar
Michael Yang committed
1326
		Args:    cobra.ExactArgs(1),
1327
1328
		PreRunE: checkServerHeartbeat,
		RunE:    PushHandler,
1329
1330
	}

1331
1332
	pushCmd.Flags().Bool("insecure", false, "Use an insecure registry")

Patrick Devine's avatar
Patrick Devine committed
1333
	listCmd := &cobra.Command{
1334
		Use:     "list",
Patrick Devine's avatar
Patrick Devine committed
1335
		Aliases: []string{"ls"},
1336
		Short:   "List models",
1337
		PreRunE: checkServerHeartbeat,
1338
		RunE:    ListHandler,
1339
1340
	}

Patrick Devine's avatar
Patrick Devine committed
1341
	copyCmd := &cobra.Command{
Michael Yang's avatar
Michael Yang committed
1342
		Use:     "cp SOURCE TARGET",
1343
		Short:   "Copy a model",
Michael Yang's avatar
Michael Yang committed
1344
		Args:    cobra.ExactArgs(2),
1345
1346
		PreRunE: checkServerHeartbeat,
		RunE:    CopyHandler,
Patrick Devine's avatar
Patrick Devine committed
1347
1348
	}

1349
	deleteCmd := &cobra.Command{
Michael Yang's avatar
Michael Yang committed
1350
		Use:     "rm MODEL [MODEL...]",
1351
1352
1353
1354
		Short:   "Remove a model",
		Args:    cobra.MinimumNArgs(1),
		PreRunE: checkServerHeartbeat,
		RunE:    DeleteHandler,
Patrick Devine's avatar
Patrick Devine committed
1355
1356
	}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1357
1358
	rootCmd.AddCommand(
		serveCmd,
1359
		createCmd,
Patrick Devine's avatar
Patrick Devine committed
1360
		showCmd,
1361
		runCmd,
1362
1363
		pullCmd,
		pushCmd,
Patrick Devine's avatar
Patrick Devine committed
1364
		listCmd,
Patrick Devine's avatar
Patrick Devine committed
1365
		copyCmd,
1366
		deleteCmd,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1367
1368
1369
1370
	)

	return rootCmd
}