cmd.go 33.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
		fmt.Fprintln(os.Stderr, "Available Commands:")
665
666
667
668
669
		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, "  /? shortcuts  Help for keyboard shortcuts")
Patrick Devine's avatar
Patrick Devine committed
670
671
672
673
674
675
676
		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:")
677
		fmt.Fprintln(os.Stderr, "  /set parameter ...     Set a parameter")
678
		fmt.Fprintln(os.Stderr, "  /set system <string>   Set system message")
679
680
681
682
683
684
685
686
687
		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
688
689
690
		fmt.Fprintln(os.Stderr, "")
	}

691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
	usageShortcuts := func() {
		fmt.Fprintln(os.Stderr, "Available keyboard shortcuts:")
		fmt.Fprintln(os.Stderr, "  Ctrl + a            Move to the beginning of the line (Home)")
		fmt.Fprintln(os.Stderr, "  Ctrl + e            Move to the end of the line (End)")
		fmt.Fprintln(os.Stderr, "   Alt + b            Move back (left) one word")
		fmt.Fprintln(os.Stderr, "   Alt + f            Move forward (right) one word")
		fmt.Fprintln(os.Stderr, "  Ctrl + k            Delete the sentence after the cursor")
		fmt.Fprintln(os.Stderr, "  Ctrl + u            Delete the sentence before the cursor")
		fmt.Fprintln(os.Stderr, "")
		fmt.Fprintln(os.Stderr, "  Ctrl + l            Clear the screen")
		fmt.Fprintln(os.Stderr, "  Ctrl + c            Stop the model from responding")
		fmt.Fprintln(os.Stderr, "  Ctrl + d            Exit ollama (/bye)")
		fmt.Fprintln(os.Stderr, "")
	}

Patrick Devine's avatar
Patrick Devine committed
706
707
708
709
710
	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")
711
		fmt.Fprintln(os.Stderr, "  /show system       Show system message")
Patrick Devine's avatar
Patrick Devine committed
712
713
		fmt.Fprintln(os.Stderr, "  /show template     Show prompt template")
		fmt.Fprintln(os.Stderr, "")
Michael Yang's avatar
Michael Yang committed
714
715
	}

716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
	// 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, "")
	}

732
	scanner, err := readline.New(readline.Prompt{
Patrick Devine's avatar
Patrick Devine committed
733
734
735
736
		Prompt:         ">>> ",
		AltPrompt:      "... ",
		Placeholder:    "Send a message (/? for help)",
		AltPlaceholder: `Use """ to end multi-line input`,
737
	})
Michael Yang's avatar
Michael Yang committed
738
739
740
741
	if err != nil {
		return err
	}

742
743
744
	fmt.Print(readline.StartBracketedPaste)
	defer fmt.Printf(readline.EndBracketedPaste)

745
	var multiline MultilineState
746
	var prompt string
747

Michael Yang's avatar
Michael Yang committed
748
749
750
751
	for {
		line, err := scanner.Readline()
		switch {
		case errors.Is(err, io.EOF):
752
			fmt.Println()
Michael Yang's avatar
Michael Yang committed
753
754
			return nil
		case errors.Is(err, readline.ErrInterrupt):
755
			if line == "" {
756
				fmt.Println("\nUse Ctrl + d or /bye to exit.")
757
758
			}

759
			scanner.Prompt.UseAlt = false
760
			prompt = ""
761

Michael Yang's avatar
Michael Yang committed
762
763
			continue
		case err != nil:
Michael Yang's avatar
Michael Yang committed
764
765
766
			return err
		}

Michael Yang's avatar
Michael Yang committed
767
		switch {
768
		case strings.HasPrefix(prompt, `"""`):
769
770
771
			// 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, `"""`)
772
			prompt += cut
773
774

			if !found {
775
				prompt += "\n"
776
777
				continue
			}
778

779
			prompt = strings.TrimPrefix(prompt, `"""`)
780
			scanner.Prompt.UseAlt = false
781
782
783

			switch multiline {
			case MultilineSystem:
784
785
				opts.System = prompt
				prompt = ""
786
				fmt.Println("Set system message.")
787
			case MultilineTemplate:
788
789
				opts.Template = prompt
				prompt = ""
790
				fmt.Println("Set prompt template.")
791
792
			}
			multiline = MultilineNone
793
		case strings.HasPrefix(line, `"""`) && len(prompt) == 0:
Patrick Devine's avatar
Patrick Devine committed
794
			scanner.Prompt.UseAlt = true
795
			multiline = MultilinePrompt
796
			prompt += line + "\n"
797
798
			continue
		case scanner.Pasting:
799
			prompt += line + "\n"
800
			continue
Michael Yang's avatar
Michael Yang committed
801
802
		case strings.HasPrefix(line, "/list"):
			args := strings.Fields(line)
803
			if err := ListHandler(cmd, args[1:]); err != nil {
Michael Yang's avatar
Michael Yang committed
804
805
806
807
808
809
810
811
812
813
				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()
814
				case "wordwrap":
815
					opts.WordWrap = true
816
817
					fmt.Println("Set 'wordwrap' mode.")
				case "nowordwrap":
818
					opts.WordWrap = false
819
					fmt.Println("Set 'nowordwrap' mode.")
Michael Yang's avatar
Michael Yang committed
820
821
				case "verbose":
					cmd.Flags().Set("verbose", "true")
822
					fmt.Println("Set 'verbose' mode.")
Michael Yang's avatar
Michael Yang committed
823
824
				case "quiet":
					cmd.Flags().Set("verbose", "false")
825
					fmt.Println("Set 'quiet' mode.")
Jeffrey Morgan's avatar
Jeffrey Morgan committed
826
827
828
829
				case "format":
					if len(args) < 3 || args[2] != "json" {
						fmt.Println("Invalid or missing format. For 'json' mode use '/set format json'")
					} else {
830
						opts.Format = args[2]
Jeffrey Morgan's avatar
Jeffrey Morgan committed
831
832
833
						fmt.Printf("Set format to '%s' mode.\n", args[2])
					}
				case "noformat":
834
					opts.Format = ""
Jeffrey Morgan's avatar
Jeffrey Morgan committed
835
					fmt.Println("Disabled format.")
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
				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]]
852
853
854
855
856
857
858
859
860
				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, `"""`)
861
						prompt += cut
862
863
						if found {
							if args[1] == "system" {
864
865
								opts.System = prompt
								fmt.Println("Set system message.")
866
							} else {
867
								opts.Template = prompt
Michael Yang's avatar
Michael Yang committed
868
								fmt.Println("Set prompt template.")
869
							}
870
							prompt = ""
871
						} else {
872
							prompt = `"""` + prompt + "\n"
873
874
875
876
877
878
879
880
							if args[1] == "system" {
								multiline = MultilineSystem
							} else {
								multiline = MultilineTemplate
							}
							scanner.Prompt.UseAlt = true
						}
					} else {
881
						opts.System = line
882
						fmt.Println("Set system message.")
883
					}
884
885
				default:
					fmt.Printf("Unknown command '/set %s'. Type /? for help\n", args[1])
886
887
				}
			} else {
Patrick Devine's avatar
Patrick Devine committed
888
				usageSet()
889
890
891
892
			}
		case strings.HasPrefix(line, "/show"):
			args := strings.Fields(line)
			if len(args) > 1 {
893
894
895
896
897
				client, err := api.ClientFromEnvironment()
				if err != nil {
					fmt.Println("error: couldn't connect to ollama server")
					return err
				}
898
				resp, err := client.Show(cmd.Context(), &api.ShowRequest{Name: opts.Model})
899
				if err != nil {
Patrick Devine's avatar
Patrick Devine committed
900
					fmt.Println("error: couldn't get model")
901
					return err
902
				}
Patrick Devine's avatar
Patrick Devine committed
903

904
905
				switch args[1] {
				case "license":
906
					if resp.License == "" {
907
						fmt.Print("No license was specified for this model.\n\n")
908
909
910
					} else {
						fmt.Println(resp.License)
					}
Patrick Devine's avatar
Patrick Devine committed
911
912
913
				case "modelfile":
					fmt.Println(resp.Modelfile)
				case "parameters":
914
					if resp.Parameters == "" {
915
						fmt.Print("No parameters were specified for this model.\n\n")
916
					} else {
917
918
919
920
921
922
923
924
						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:")
925
926
						fmt.Println(resp.Parameters)
					}
927
				case "system":
928
					switch {
929
930
					case opts.System != "":
						fmt.Println(opts.System + "\n")
931
932
933
					case resp.System != "":
						fmt.Println(resp.System + "\n")
					default:
934
						fmt.Print("No system message was specified for this model.\n\n")
935
					}
936
				case "template":
937
938
939
940
					switch {
					case opts.Template != "":
						fmt.Println(opts.Template + "\n")
					case resp.Template != "":
941
						fmt.Println(resp.Template)
942
943
					default:
						fmt.Print("No prompt template was specified for this model.\n\n")
944
					}
945
				default:
946
					fmt.Printf("Unknown command '/show %s'. Type /? for help\n", args[1])
Michael Yang's avatar
Michael Yang committed
947
				}
Patrick Devine's avatar
Patrick Devine committed
948
949
950
951
952
953
954
955
956
957
958
			} 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()
959
960
				case "shortcut", "shortcuts":
					usageShortcuts()
Patrick Devine's avatar
Patrick Devine committed
961
				}
962
963
			} else {
				usage()
Michael Yang's avatar
Michael Yang committed
964
965
966
			}
		case line == "/exit", line == "/bye":
			return nil
967
968
		case strings.HasPrefix(line, "/"):
			args := strings.Fields(line)
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
			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
			}
986
		default:
987
			prompt += line
Michael Yang's avatar
Michael Yang committed
988
989
		}

990
991
		if len(prompt) > 0 && multiline == MultilineNone {
			opts.Prompt = prompt
Patrick Devine's avatar
Patrick Devine committed
992
			if multiModal {
993
				newPrompt, images, err := extractFileData(prompt)
Patrick Devine's avatar
Patrick Devine committed
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
				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
1007
1008
					fmt.Println("This model requires you to add a jpeg, png, or svg image.")
					fmt.Println()
Patrick Devine's avatar
Patrick Devine committed
1009
1010
1011
1012
					prompt = ""
					continue
				}
			}
1013
			if err := generate(cmd, opts); err != nil {
Patrick Devine's avatar
Patrick Devine committed
1014
1015
				return err
			}
1016

1017
			prompt = ""
Michael Yang's avatar
Michael Yang committed
1018
1019
		}
	}
Bruce MacDonald's avatar
Bruce MacDonald committed
1020
1021
}

Patrick Devine's avatar
Patrick Devine committed
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
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
}

1047
func extractFileNames(input string) []string {
Patrick Devine's avatar
Patrick Devine committed
1048
1049
1050
1051
1052
	// 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)

1053
1054
1055
1056
1057
	return re.FindAllString(input, -1)
}

func extractFileData(input string) (string, []ImageData, error) {
	filePaths := extractFileNames(input)
Patrick Devine's avatar
Patrick Devine committed
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
	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
}

1077
func RunServer(cmd *cobra.Command, _ []string) error {
Michael Yang's avatar
Michael Yang committed
1078
1079
1080
	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
1081
		if ip := net.ParseIP(strings.Trim(os.Getenv("OLLAMA_HOST"), "[]")); ip != nil {
Michael Yang's avatar
Michael Yang committed
1082
1083
			host = ip.String()
		}
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1084
	}
1085

Michael Yang's avatar
Michael Yang committed
1086
	if err := initializeKeypair(); err != nil {
1087
1088
1089
		return err
	}

Michael Yang's avatar
Michael Yang committed
1090
	ln, err := net.Listen("tcp", net.JoinHostPort(host, port))
1091
1092
1093
	if err != nil {
		return err
	}
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1094

1095
	return server.Serve(ln)
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1096
1097
}

Patrick Devine's avatar
Patrick Devine committed
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
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
1125
		return nil, fmt.Errorf("file size exceeds maximum limit (100MB)")
Patrick Devine's avatar
Patrick Devine committed
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
	}

	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
}

1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
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
1164
		err = os.MkdirAll(filepath.Dir(privKeyPath), 0o755)
1165
1166
1167
1168
		if err != nil {
			return fmt.Errorf("could not create directory %w", err)
		}

1169
		err = os.WriteFile(privKeyPath, pem.EncodeToMemory(privKeyBytes), 0o600)
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
		if err != nil {
			return err
		}

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

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

1181
		err = os.WriteFile(pubKeyPath, pubKeyData, 0o644)
1182
1183
1184
1185
1186
1187
1188
1189
1190
		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
1191
func startMacApp(ctx context.Context, client *api.Client) error {
Bruce MacDonald's avatar
Bruce MacDonald committed
1192
1193
1194
1195
1196
	exe, err := os.Executable()
	if err != nil {
		return err
	}
	link, err := os.Readlink(exe)
Bruce MacDonald's avatar
Bruce MacDonald committed
1197
1198
1199
	if err != nil {
		return err
	}
Bruce MacDonald's avatar
Bruce MacDonald committed
1200
1201
1202
	if !strings.Contains(link, "Ollama.app") {
		return fmt.Errorf("could not find ollama app")
	}
Bruce MacDonald's avatar
Bruce MacDonald committed
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
	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
1215
			if err := client.Heartbeat(ctx); err == nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1216
1217
1218
1219
1220
1221
				return nil // server has started
			}
		}
	}
}

Michael Yang's avatar
Michael Yang committed
1222
func checkServerHeartbeat(cmd *cobra.Command, _ []string) error {
Michael Yang's avatar
Michael Yang committed
1223
	client, err := api.ClientFromEnvironment()
1224
1225
1226
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
1227
	if err := client.Heartbeat(cmd.Context()); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1228
1229
1230
1231
		if !strings.Contains(err.Error(), "connection refused") {
			return err
		}
		if runtime.GOOS == "darwin" {
Michael Yang's avatar
Michael Yang committed
1232
			if err := startMacApp(cmd.Context(), client); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1233
				return fmt.Errorf("could not connect to ollama app, is it running?")
1234
			}
Bruce MacDonald's avatar
Bruce MacDonald committed
1235
		} else {
1236
1237
1238
1239
1240
1241
			return fmt.Errorf("could not connect to ollama server, run 'ollama serve' to start it")
		}
	}
	return nil
}

Michael Yang's avatar
Michael Yang committed
1242
1243
1244
1245
1246
1247
1248
1249
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
1250
1251
1252
1253
1254
		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
1255
1256
	}

1257
	if serverVersion != version.Version {
Michael Yang's avatar
Michael Yang committed
1258
		fmt.Printf("Warning: client version is %s\n", version.Version)
1259
	}
Michael Yang's avatar
Michael Yang committed
1260
1261
}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1262
1263
func NewCLI() *cobra.Command {
	log.SetFlags(log.LstdFlags | log.Lshortfile)
Michael Yang's avatar
Michael Yang committed
1264
	cobra.EnableCommandSorting = false
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1265
1266

	rootCmd := &cobra.Command{
1267
1268
1269
1270
		Use:           "ollama",
		Short:         "Large language model runner",
		SilenceUsage:  true,
		SilenceErrors: true,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1271
1272
1273
		CompletionOptions: cobra.CompletionOptions{
			DisableDefaultCmd: true,
		},
Michael Yang's avatar
Michael Yang committed
1274
1275
1276
1277
1278
1279
1280
1281
		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
1282
1283
	}

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

1286
	createCmd := &cobra.Command{
1287
1288
		Use:     "create MODEL",
		Short:   "Create a model from a Modelfile",
Michael Yang's avatar
Michael Yang committed
1289
		Args:    cobra.ExactArgs(1),
1290
1291
		PreRunE: checkServerHeartbeat,
		RunE:    CreateHandler,
1292
1293
1294
1295
	}

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

Patrick Devine's avatar
Patrick Devine committed
1296
1297
1298
	showCmd := &cobra.Command{
		Use:     "show MODEL",
		Short:   "Show information for a model",
Michael Yang's avatar
Michael Yang committed
1299
		Args:    cobra.ExactArgs(1),
Patrick Devine's avatar
Patrick Devine committed
1300
1301
1302
1303
1304
1305
1306
1307
		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")
1308
	showCmd.Flags().Bool("system", false, "Show system message of a model")
Patrick Devine's avatar
Patrick Devine committed
1309

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1310
	runCmd := &cobra.Command{
1311
1312
1313
1314
1315
		Use:     "run MODEL [PROMPT]",
		Short:   "Run a model",
		Args:    cobra.MinimumNArgs(1),
		PreRunE: checkServerHeartbeat,
		RunE:    RunHandler,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1316
1317
	}

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

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1323
1324
1325
1326
	serveCmd := &cobra.Command{
		Use:     "serve",
		Aliases: []string{"start"},
		Short:   "Start ollama",
Michael Yang's avatar
Michael Yang committed
1327
		Args:    cobra.ExactArgs(0),
Michael Yang's avatar
Michael Yang committed
1328
		RunE:    RunServer,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1329
1330
	}

1331
	pullCmd := &cobra.Command{
1332
1333
		Use:     "pull MODEL",
		Short:   "Pull a model from a registry",
Michael Yang's avatar
Michael Yang committed
1334
		Args:    cobra.ExactArgs(1),
1335
1336
		PreRunE: checkServerHeartbeat,
		RunE:    PullHandler,
1337
1338
	}

1339
1340
	pullCmd.Flags().Bool("insecure", false, "Use an insecure registry")

1341
	pushCmd := &cobra.Command{
1342
1343
		Use:     "push MODEL",
		Short:   "Push a model to a registry",
Michael Yang's avatar
Michael Yang committed
1344
		Args:    cobra.ExactArgs(1),
1345
1346
		PreRunE: checkServerHeartbeat,
		RunE:    PushHandler,
1347
1348
	}

1349
1350
	pushCmd.Flags().Bool("insecure", false, "Use an insecure registry")

Patrick Devine's avatar
Patrick Devine committed
1351
	listCmd := &cobra.Command{
1352
		Use:     "list",
Patrick Devine's avatar
Patrick Devine committed
1353
		Aliases: []string{"ls"},
1354
		Short:   "List models",
1355
		PreRunE: checkServerHeartbeat,
1356
		RunE:    ListHandler,
1357
1358
	}

Patrick Devine's avatar
Patrick Devine committed
1359
	copyCmd := &cobra.Command{
Michael Yang's avatar
Michael Yang committed
1360
		Use:     "cp SOURCE TARGET",
1361
		Short:   "Copy a model",
Michael Yang's avatar
Michael Yang committed
1362
		Args:    cobra.ExactArgs(2),
1363
1364
		PreRunE: checkServerHeartbeat,
		RunE:    CopyHandler,
Patrick Devine's avatar
Patrick Devine committed
1365
1366
	}

1367
	deleteCmd := &cobra.Command{
Michael Yang's avatar
Michael Yang committed
1368
		Use:     "rm MODEL [MODEL...]",
1369
1370
1371
1372
		Short:   "Remove a model",
		Args:    cobra.MinimumNArgs(1),
		PreRunE: checkServerHeartbeat,
		RunE:    DeleteHandler,
Patrick Devine's avatar
Patrick Devine committed
1373
1374
	}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1375
1376
	rootCmd.AddCommand(
		serveCmd,
1377
		createCmd,
Patrick Devine's avatar
Patrick Devine committed
1378
		showCmd,
1379
		runCmd,
1380
1381
		pullCmd,
		pushCmd,
Patrick Devine's avatar
Patrick Devine committed
1382
		listCmd,
Patrick Devine's avatar
Patrick Devine committed
1383
		copyCmd,
1384
		deleteCmd,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1385
1386
1387
1388
	)

	return rootCmd
}