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

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

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

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

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

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

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

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

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

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

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

Michael Yang's avatar
Michael Yang committed
89
90
			bin, err := os.Open(path)
			if errors.Is(err, os.ErrNotExist) && c.Name == "model" {
Michael Yang's avatar
Michael Yang committed
91
				continue
Michael Yang's avatar
Michael Yang committed
92
93
94
95
96
97
98
99
100
101
102
103
			} 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
104
			if err = client.CreateBlob(cmd.Context(), digest, bin); err != nil {
Michael Yang's avatar
Michael Yang committed
105
106
107
				return err
			}

Michael Yang's avatar
Michael Yang committed
108
			modelfile = bytes.ReplaceAll(modelfile, []byte(c.Args), []byte("@"+digest))
Michael Yang's avatar
Michael Yang committed
109
110
		}
	}
Michael Yang's avatar
Michael Yang committed
111

112
	fn := func(resp api.ProgressResponse) error {
Michael Yang's avatar
Michael Yang committed
113
114
115
116
117
		if resp.Digest != "" {
			spinner.Stop()

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

132
133
134
		return nil
	}

135
	request := api.CreateRequest{Name: args[0], Modelfile: string(modelfile)}
136
137
138
139
140
141
142
	if err := client.Create(context.Background(), &request, fn); err != nil {
		return err
	}

	return nil
}

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

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

162
	return RunGenerate(cmd, args)
Bruce MacDonald's avatar
Bruce MacDonald committed
163
164
}

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

171
172
173
174
175
	insecure, err := cmd.Flags().GetBool("insecure")
	if err != nil {
		return err
	}

Michael Yang's avatar
Michael Yang committed
176
177
178
179
	p := progress.NewProgress(os.Stderr)
	defer p.Stop()

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

183
	fn := func(resp api.ProgressResponse) error {
Michael Yang's avatar
Michael Yang committed
184
		if resp.Digest != "" {
185
186
187
			if spinner != nil {
				spinner.Stop()
			}
Michael Yang's avatar
Michael Yang committed
188
189
190

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

			bar.Set(resp.Completed)
		} else if status != resp.Status {
198
199
200
			if spinner != nil {
				spinner.Stop()
			}
Michael Yang's avatar
Michael Yang committed
201
202
203
204
205
206

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

207
208
209
		return nil
	}

Michael Yang's avatar
Michael Yang committed
210
211
212
213
214
	request := api.PushRequest{Name: args[0], Insecure: insecure}
	if err := client.Push(context.Background(), &request, fn); err != nil {
		return err
	}

215
	spinner.Stop()
Michael Yang's avatar
Michael Yang committed
216
	return nil
217
218
}

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

	models, err := client.List(context.Background())
	if err != nil {
		return err
	}

	var data [][]string

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

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

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

258
259
260
261
262
263
	for _, name := range args {
		req := api.DeleteRequest{Name: name}
		if err := client.Delete(context.Background(), &req); err != nil {
			return err
		}
		fmt.Printf("deleted '%s'\n", name)
264
265
266
267
	}
	return nil
}

Patrick Devine's avatar
Patrick Devine committed
268
func ShowHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
269
	client, err := api.ClientFromEnvironment()
Patrick Devine's avatar
Patrick Devine committed
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
	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 {
319
		return errors.New("only one of '--license', '--modelfile', '--parameters', '--system', or '--template' can be specified")
Patrick Devine's avatar
Patrick Devine committed
320
	} else if flagsSet == 0 {
321
		return errors.New("one of '--license', '--modelfile', '--parameters', '--system', or '--template' must be specified")
Patrick Devine's avatar
Patrick Devine committed
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
	}

	req := api.ShowRequest{Name: args[0]}
	resp, err := client.Show(context.Background(), &req)
	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
346
func CopyHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
347
	client, err := api.ClientFromEnvironment()
348
349
350
	if err != nil {
		return err
	}
Patrick Devine's avatar
Patrick Devine committed
351
352
353
354
355
356
357
358
359

	req := api.CopyRequest{Source: args[0], Destination: args[1]}
	if err := client.Copy(context.Background(), &req); err != nil {
		return err
	}
	fmt.Printf("copied '%s' to '%s'\n", args[0], args[1])
	return nil
}

360
func PullHandler(cmd *cobra.Command, args []string) error {
361
362
363
364
365
	insecure, err := cmd.Flags().GetBool("insecure")
	if err != nil {
		return err
	}

Michael Yang's avatar
Michael Yang committed
366
	client, err := api.ClientFromEnvironment()
367
368
369
	if err != nil {
		return err
	}
370

Michael Yang's avatar
Michael Yang committed
371
372
373
374
375
	p := progress.NewProgress(os.Stderr)
	defer p.Stop()

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

376
377
	var status string
	var spinner *progress.Spinner
Michael Yang's avatar
Michael Yang committed
378

379
	fn := func(resp api.ProgressResponse) error {
Michael Yang's avatar
Michael Yang committed
380
		if resp.Digest != "" {
381
382
383
			if spinner != nil {
				spinner.Stop()
			}
Michael Yang's avatar
Michael Yang committed
384
385
386

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

			bar.Set(resp.Completed)
		} else if status != resp.Status {
394
395
396
			if spinner != nil {
				spinner.Stop()
			}
Michael Yang's avatar
Michael Yang committed
397
398
399
400
401
402

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

403
404
		return nil
	}
405

Michael Yang's avatar
Michael Yang committed
406
407
408
409
410
411
	request := api.PullRequest{Name: args[0], Insecure: insecure}
	if err := client.Pull(context.Background(), &request, fn); err != nil {
		return err
	}

	return nil
Michael Yang's avatar
Michael Yang committed
412
413
}

414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
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{}{},
	}

	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 {
463
	Model    string
464
	Prompt   string
465
466
	WordWrap bool
	Format   string
467
	System   string
468
	Template string
469
470
471
	Options  map[string]interface{}
}

472
func generate(cmd *cobra.Command, opts generateOptions) error {
Michael Yang's avatar
Michael Yang committed
473
	client, err := api.ClientFromEnvironment()
Patrick Devine's avatar
Patrick Devine committed
474
	if err != nil {
475
		return err
Patrick Devine's avatar
Patrick Devine committed
476
	}
Michael Yang's avatar
Michael Yang committed
477

Michael Yang's avatar
Michael Yang committed
478
	p := progress.NewProgress(os.Stderr)
479
	defer p.StopAndClear()
480

Michael Yang's avatar
Michael Yang committed
481
482
483
	spinner := progress.NewSpinner("")
	p.Add("", spinner)

484
485
486
487
488
489
490
	var latest api.GenerateResponse

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

491
	termWidth, _, err := term.GetSize(int(os.Stdout.Fd()))
492
	if err != nil {
493
		opts.WordWrap = false
494
495
	}

496
497
498
499
500
501
502
503
504
505
506
	cancelCtx, cancel := context.WithCancel(context.Background())
	defer cancel()

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

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

507
508
509
	var currentLineLength int
	var wordBuffer string

510
511
512
513
514
515
516
517
518
519
	request := api.GenerateRequest{
		Model:    opts.Model,
		Prompt:   opts.Prompt,
		Context:  generateContext,
		Format:   opts.Format,
		System:   opts.System,
		Template: opts.Template,
		Options:  opts.Options,
	}
	fn := func(response api.GenerateResponse) error {
Michael Yang's avatar
Michael Yang committed
520
		p.StopAndClear()
521

Patrick Devine's avatar
Patrick Devine committed
522
		latest = response
523

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

535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
					// 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 {
554
			fmt.Printf("%s%s", wordBuffer, response.Response)
555
556
557
			if len(wordBuffer) > 0 {
				wordBuffer = ""
			}
558
559
		}

Patrick Devine's avatar
Patrick Devine committed
560
561
		return nil
	}
562

563
	if err := client.Generate(cancelCtx, &request, fn); err != nil {
564
		if errors.Is(err, context.Canceled) {
565
			return nil
566
		}
567
		return err
Patrick Devine's avatar
Patrick Devine committed
568
	}
569
	if opts.Prompt != "" {
Michael Yang's avatar
Michael Yang committed
570
571
		fmt.Println()
		fmt.Println()
Patrick Devine's avatar
Patrick Devine committed
572
	}
573

574
575
576
577
	if !latest.Done {
		return nil
	}

Patrick Devine's avatar
Patrick Devine committed
578
579
	verbose, err := cmd.Flags().GetBool("verbose")
	if err != nil {
580
		return err
Patrick Devine's avatar
Patrick Devine committed
581
	}
Michael Yang's avatar
Michael Yang committed
582

Patrick Devine's avatar
Patrick Devine committed
583
584
	if verbose {
		latest.Summary()
Michael Yang's avatar
Michael Yang committed
585
	}
Michael Yang's avatar
Michael Yang committed
586

587
588
589
590
591
	ctx := cmd.Context()
	ctx = context.WithValue(ctx, generateContextKey("context"), latest.Context)
	cmd.SetContext(ctx)

	return nil
Michael Yang's avatar
Michael Yang committed
592
593
}

594
595
596
597
598
599
600
601
602
type MultilineState int

const (
	MultilineNone MultilineState = iota
	MultilinePrompt
	MultilineSystem
	MultilineTemplate
)

603
func generateInteractive(cmd *cobra.Command, opts generateOptions) error {
Patrick Devine's avatar
Patrick Devine committed
604
	// load the model
605
606
607
608
609
	loadOpts := generateOptions{
		Model:  opts.Model,
		Prompt: "",
	}
	if err := generate(cmd, loadOpts); err != nil {
Patrick Devine's avatar
Patrick Devine committed
610
611
612
		return err
	}

Michael Yang's avatar
Michael Yang committed
613
	usage := func() {
Patrick Devine's avatar
Patrick Devine committed
614
615
616
617
618
619
620
621
622
623
624
625
		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:")
626
627
628
629
630
631
632
633
634
635
636
		fmt.Fprintln(os.Stderr, "  /set parameter ...     Set a parameter")
		fmt.Fprintln(os.Stderr, "  /set system <string>   Set system prompt")
		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
637
638
639
640
641
642
643
644
645
646
647
		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")
		fmt.Fprintln(os.Stderr, "  /show system       Show system prompt")
		fmt.Fprintln(os.Stderr, "  /show template     Show prompt template")
		fmt.Fprintln(os.Stderr, "")
Michael Yang's avatar
Michael Yang committed
648
649
	}

650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
	// 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, "")
	}

666
	scanner, err := readline.New(readline.Prompt{
Patrick Devine's avatar
Patrick Devine committed
667
668
669
670
		Prompt:         ">>> ",
		AltPrompt:      "... ",
		Placeholder:    "Send a message (/? for help)",
		AltPlaceholder: `Use """ to end multi-line input`,
671
	})
Michael Yang's avatar
Michael Yang committed
672
673
674
675
	if err != nil {
		return err
	}

676
677
678
	fmt.Print(readline.StartBracketedPaste)
	defer fmt.Printf(readline.EndBracketedPaste)

679
	var multiline MultilineState
680
	var prompt string
681

Michael Yang's avatar
Michael Yang committed
682
683
684
685
	for {
		line, err := scanner.Readline()
		switch {
		case errors.Is(err, io.EOF):
686
			fmt.Println()
Michael Yang's avatar
Michael Yang committed
687
688
			return nil
		case errors.Is(err, readline.ErrInterrupt):
689
			if line == "" {
Patrick Devine's avatar
Patrick Devine committed
690
				fmt.Println("\nUse Ctrl-D or /bye to exit.")
691
692
			}

693
			scanner.Prompt.UseAlt = false
694
			prompt = ""
695

Michael Yang's avatar
Michael Yang committed
696
697
			continue
		case err != nil:
Michael Yang's avatar
Michael Yang committed
698
699
700
			return err
		}

Michael Yang's avatar
Michael Yang committed
701
		switch {
702
		case strings.HasPrefix(prompt, `"""`):
703
704
705
			// 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, `"""`)
706
			prompt += cut + "\n"
707
708

			if !found {
709
710
				continue
			}
711

712
			prompt = strings.TrimPrefix(prompt, `"""`)
713
			scanner.Prompt.UseAlt = false
714
715
716

			switch multiline {
			case MultilineSystem:
717
718
				opts.System = prompt
				prompt = ""
719
720
				fmt.Println("Set system template.\n")
			case MultilineTemplate:
721
722
				opts.Template = prompt
				prompt = ""
723
724
725
				fmt.Println("Set model template.\n")
			}
			multiline = MultilineNone
726
		case strings.HasPrefix(line, `"""`) && len(prompt) == 0:
Patrick Devine's avatar
Patrick Devine committed
727
			scanner.Prompt.UseAlt = true
728
			multiline = MultilinePrompt
729
			prompt += line + "\n"
730
731
			continue
		case scanner.Pasting:
732
			prompt += line + "\n"
733
			continue
Michael Yang's avatar
Michael Yang committed
734
735
		case strings.HasPrefix(line, "/list"):
			args := strings.Fields(line)
736
			if err := ListHandler(cmd, args[1:]); err != nil {
Michael Yang's avatar
Michael Yang committed
737
738
739
740
741
742
743
744
745
746
				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()
747
				case "wordwrap":
748
					opts.WordWrap = true
749
750
					fmt.Println("Set 'wordwrap' mode.")
				case "nowordwrap":
751
					opts.WordWrap = false
752
					fmt.Println("Set 'nowordwrap' mode.")
Michael Yang's avatar
Michael Yang committed
753
754
				case "verbose":
					cmd.Flags().Set("verbose", "true")
755
					fmt.Println("Set 'verbose' mode.")
Michael Yang's avatar
Michael Yang committed
756
757
				case "quiet":
					cmd.Flags().Set("verbose", "false")
758
					fmt.Println("Set 'quiet' mode.")
Jeffrey Morgan's avatar
Jeffrey Morgan committed
759
760
761
762
				case "format":
					if len(args) < 3 || args[2] != "json" {
						fmt.Println("Invalid or missing format. For 'json' mode use '/set format json'")
					} else {
763
						opts.Format = args[2]
Jeffrey Morgan's avatar
Jeffrey Morgan committed
764
765
766
						fmt.Printf("Set format to '%s' mode.\n", args[2])
					}
				case "noformat":
767
					opts.Format = ""
Jeffrey Morgan's avatar
Jeffrey Morgan committed
768
					fmt.Println("Disabled format.")
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
				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]]
785
786
787
788
789
790
791
792
793
				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, `"""`)
794
						prompt += cut + "\n"
795
						if found {
796
							opts.System = prompt
797
798
799
800
801
							if args[1] == "system" {
								fmt.Println("Set system template.\n")
							} else {
								fmt.Println("Set prompt template.\n")
							}
802
							prompt = ""
803
						} else {
804
							prompt = `"""` + prompt
805
806
807
808
809
810
811
812
							if args[1] == "system" {
								multiline = MultilineSystem
							} else {
								multiline = MultilineTemplate
							}
							scanner.Prompt.UseAlt = true
						}
					} else {
813
						opts.System = line
814
815
						fmt.Println("Set system template.\n")
					}
816
817
				default:
					fmt.Printf("Unknown command '/set %s'. Type /? for help\n", args[1])
818
819
				}
			} else {
Patrick Devine's avatar
Patrick Devine committed
820
				usageSet()
821
822
823
824
			}
		case strings.HasPrefix(line, "/show"):
			args := strings.Fields(line)
			if len(args) > 1 {
825
826
827
828
829
				client, err := api.ClientFromEnvironment()
				if err != nil {
					fmt.Println("error: couldn't connect to ollama server")
					return err
				}
830
				resp, err := client.Show(cmd.Context(), &api.ShowRequest{Name: opts.Model})
831
				if err != nil {
Patrick Devine's avatar
Patrick Devine committed
832
					fmt.Println("error: couldn't get model")
833
					return err
834
				}
Patrick Devine's avatar
Patrick Devine committed
835

836
837
				switch args[1] {
				case "license":
838
					if resp.License == "" {
839
						fmt.Print("No license was specified for this model.\n\n")
840
841
842
					} else {
						fmt.Println(resp.License)
					}
Patrick Devine's avatar
Patrick Devine committed
843
844
845
				case "modelfile":
					fmt.Println(resp.Modelfile)
				case "parameters":
846
					if resp.Parameters == "" {
847
						fmt.Print("No parameters were specified for this model.\n\n")
848
					} else {
849
850
851
852
853
854
855
856
						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:")
857
858
						fmt.Println(resp.Parameters)
					}
859
				case "system":
860
					switch {
861
862
					case opts.System != "":
						fmt.Println(opts.System + "\n")
863
864
865
					case resp.System != "":
						fmt.Println(resp.System + "\n")
					default:
866
						fmt.Print("No system prompt was specified for this model.\n\n")
867
					}
868
				case "template":
869
870
871
872
					switch {
					case opts.Template != "":
						fmt.Println(opts.Template + "\n")
					case resp.Template != "":
873
						fmt.Println(resp.Template)
874
875
					default:
						fmt.Print("No prompt template was specified for this model.\n\n")
876
					}
877
				default:
878
					fmt.Printf("Unknown command '/show %s'. Type /? for help\n", args[1])
Michael Yang's avatar
Michael Yang committed
879
				}
Patrick Devine's avatar
Patrick Devine committed
880
881
882
883
884
885
886
887
888
889
890
891
			} 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()
				}
892
893
			} else {
				usage()
Michael Yang's avatar
Michael Yang committed
894
895
896
			}
		case line == "/exit", line == "/bye":
			return nil
897
898
899
		case strings.HasPrefix(line, "/"):
			args := strings.Fields(line)
			fmt.Printf("Unknown command '%s'. Type /? for help\n", args[0])
900
901
			continue
		default:
902
			prompt += line
Michael Yang's avatar
Michael Yang committed
903
904
		}

905
906
907
		if len(prompt) > 0 && multiline == MultilineNone {
			opts.Prompt = prompt
			if err := generate(cmd, opts); err != nil {
Patrick Devine's avatar
Patrick Devine committed
908
909
				return err
			}
910

911
			prompt = ""
Michael Yang's avatar
Michael Yang committed
912
913
		}
	}
Bruce MacDonald's avatar
Bruce MacDonald committed
914
915
}

916
func RunServer(cmd *cobra.Command, _ []string) error {
Michael Yang's avatar
Michael Yang committed
917
918
919
	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
920
		if ip := net.ParseIP(strings.Trim(os.Getenv("OLLAMA_HOST"), "[]")); ip != nil {
Michael Yang's avatar
Michael Yang committed
921
922
			host = ip.String()
		}
Jeffrey Morgan's avatar
Jeffrey Morgan committed
923
	}
924

Michael Yang's avatar
Michael Yang committed
925
	if err := initializeKeypair(); err != nil {
926
927
928
		return err
	}

Michael Yang's avatar
Michael Yang committed
929
	ln, err := net.Listen("tcp", net.JoinHostPort(host, port))
930
931
932
	if err != nil {
		return err
	}
Jeffrey Morgan's avatar
Jeffrey Morgan committed
933

934
935
936
937
938
	var origins []string
	if o := os.Getenv("OLLAMA_ORIGINS"); o != "" {
		origins = strings.Split(o, ",")
	}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
939
	return server.Serve(ln, origins)
Jeffrey Morgan's avatar
Jeffrey Morgan committed
940
941
}

942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
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
964
		err = os.MkdirAll(filepath.Dir(privKeyPath), 0o755)
965
966
967
968
		if err != nil {
			return fmt.Errorf("could not create directory %w", err)
		}

969
		err = os.WriteFile(privKeyPath, pem.EncodeToMemory(privKeyBytes), 0o600)
970
971
972
973
974
975
976
977
978
979
980
		if err != nil {
			return err
		}

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

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

981
		err = os.WriteFile(pubKeyPath, pubKeyData, 0o644)
982
983
984
985
986
987
988
989
990
		if err != nil {
			return err
		}

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

Bruce MacDonald's avatar
Bruce MacDonald committed
991
func startMacApp(client *api.Client) error {
Bruce MacDonald's avatar
Bruce MacDonald committed
992
993
994
995
996
	exe, err := os.Executable()
	if err != nil {
		return err
	}
	link, err := os.Readlink(exe)
Bruce MacDonald's avatar
Bruce MacDonald committed
997
998
999
	if err != nil {
		return err
	}
Bruce MacDonald's avatar
Bruce MacDonald committed
1000
1001
1002
	if !strings.Contains(link, "Ollama.app") {
		return fmt.Errorf("could not find ollama app")
	}
Bruce MacDonald's avatar
Bruce MacDonald committed
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
	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:
			if err := client.Heartbeat(context.Background()); err == nil {
				return nil // server has started
			}
		}
	}
}

1022
func checkServerHeartbeat(_ *cobra.Command, _ []string) error {
Michael Yang's avatar
Michael Yang committed
1023
	client, err := api.ClientFromEnvironment()
1024
1025
1026
	if err != nil {
		return err
	}
1027
	if err := client.Heartbeat(context.Background()); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1028
1029
1030
1031
1032
		if !strings.Contains(err.Error(), "connection refused") {
			return err
		}
		if runtime.GOOS == "darwin" {
			if err := startMacApp(client); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1033
				return fmt.Errorf("could not connect to ollama app, is it running?")
1034
			}
Bruce MacDonald's avatar
Bruce MacDonald committed
1035
		} else {
1036
1037
1038
1039
1040
1041
			return fmt.Errorf("could not connect to ollama server, run 'ollama serve' to start it")
		}
	}
	return nil
}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1042
1043
1044
1045
func NewCLI() *cobra.Command {
	log.SetFlags(log.LstdFlags | log.Lshortfile)

	rootCmd := &cobra.Command{
1046
1047
1048
1049
		Use:           "ollama",
		Short:         "Large language model runner",
		SilenceUsage:  true,
		SilenceErrors: true,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1050
1051
1052
		CompletionOptions: cobra.CompletionOptions{
			DisableDefaultCmd: true,
		},
Michael Yang's avatar
Michael Yang committed
1053
		Version: version.Version,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1054
1055
1056
1057
	}

	cobra.EnableCommandSorting = false

1058
	createCmd := &cobra.Command{
1059
1060
		Use:     "create MODEL",
		Short:   "Create a model from a Modelfile",
Michael Yang's avatar
Michael Yang committed
1061
		Args:    cobra.ExactArgs(1),
1062
1063
		PreRunE: checkServerHeartbeat,
		RunE:    CreateHandler,
1064
1065
1066
1067
	}

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

Patrick Devine's avatar
Patrick Devine committed
1068
1069
1070
	showCmd := &cobra.Command{
		Use:     "show MODEL",
		Short:   "Show information for a model",
Michael Yang's avatar
Michael Yang committed
1071
		Args:    cobra.ExactArgs(1),
Patrick Devine's avatar
Patrick Devine committed
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
		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")
	showCmd.Flags().Bool("system", false, "Show system prompt of a model")

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1082
	runCmd := &cobra.Command{
1083
1084
1085
1086
1087
		Use:     "run MODEL [PROMPT]",
		Short:   "Run a model",
		Args:    cobra.MinimumNArgs(1),
		PreRunE: checkServerHeartbeat,
		RunE:    RunHandler,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1088
1089
	}

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

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1095
1096
1097
1098
	serveCmd := &cobra.Command{
		Use:     "serve",
		Aliases: []string{"start"},
		Short:   "Start ollama",
Michael Yang's avatar
Michael Yang committed
1099
		Args:    cobra.ExactArgs(0),
Michael Yang's avatar
Michael Yang committed
1100
		RunE:    RunServer,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1101
1102
	}

1103
	pullCmd := &cobra.Command{
1104
1105
		Use:     "pull MODEL",
		Short:   "Pull a model from a registry",
Michael Yang's avatar
Michael Yang committed
1106
		Args:    cobra.ExactArgs(1),
1107
1108
		PreRunE: checkServerHeartbeat,
		RunE:    PullHandler,
1109
1110
	}

1111
1112
	pullCmd.Flags().Bool("insecure", false, "Use an insecure registry")

1113
	pushCmd := &cobra.Command{
1114
1115
		Use:     "push MODEL",
		Short:   "Push a model to a registry",
Michael Yang's avatar
Michael Yang committed
1116
		Args:    cobra.ExactArgs(1),
1117
1118
		PreRunE: checkServerHeartbeat,
		RunE:    PushHandler,
1119
1120
	}

1121
1122
	pushCmd.Flags().Bool("insecure", false, "Use an insecure registry")

Patrick Devine's avatar
Patrick Devine committed
1123
	listCmd := &cobra.Command{
1124
		Use:     "list",
Patrick Devine's avatar
Patrick Devine committed
1125
		Aliases: []string{"ls"},
1126
		Short:   "List models",
1127
		PreRunE: checkServerHeartbeat,
1128
		RunE:    ListHandler,
1129
1130
	}

Patrick Devine's avatar
Patrick Devine committed
1131
	copyCmd := &cobra.Command{
Michael Yang's avatar
Michael Yang committed
1132
		Use:     "cp SOURCE TARGET",
1133
		Short:   "Copy a model",
Michael Yang's avatar
Michael Yang committed
1134
		Args:    cobra.ExactArgs(2),
1135
1136
		PreRunE: checkServerHeartbeat,
		RunE:    CopyHandler,
Patrick Devine's avatar
Patrick Devine committed
1137
1138
	}

1139
	deleteCmd := &cobra.Command{
Michael Yang's avatar
Michael Yang committed
1140
		Use:     "rm MODEL [MODEL...]",
1141
1142
1143
1144
		Short:   "Remove a model",
		Args:    cobra.MinimumNArgs(1),
		PreRunE: checkServerHeartbeat,
		RunE:    DeleteHandler,
Patrick Devine's avatar
Patrick Devine committed
1145
1146
	}

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

	return rootCmd
}