cmd.go 27.5 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)}
Michael Yang's avatar
Michael Yang committed
136
	if err := client.Create(cmd.Context(), &request, fn); err != nil {
137
138
139
140
141
142
		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
	name := args[0]
	// check if the model exists on the server
Michael Yang's avatar
Michael Yang committed
151
	_, err = client.Show(cmd.Context(), &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
	request := api.PushRequest{Name: args[0], Insecure: insecure}
Michael Yang's avatar
Michael Yang committed
211
	if err := client.Push(cmd.Context(), &request, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
212
213
214
		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

Michael Yang's avatar
Michael Yang committed
225
	models, err := client.List(cmd.Context())
Patrick Devine's avatar
Patrick Devine committed
226
227
228
229
230
231
232
	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
	for _, name := range args {
		req := api.DeleteRequest{Name: name}
Michael Yang's avatar
Michael Yang committed
260
		if err := client.Delete(cmd.Context(), &req); err != nil {
261
262
263
			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
	}

	req := api.ShowRequest{Name: args[0]}
Michael Yang's avatar
Michael Yang committed
325
	resp, err := client.Show(cmd.Context(), &req)
Patrick Devine's avatar
Patrick Devine committed
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
	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

	req := api.CopyRequest{Source: args[0], Destination: args[1]}
Michael Yang's avatar
Michael Yang committed
353
	if err := client.Copy(cmd.Context(), &req); err != nil {
Patrick Devine's avatar
Patrick Devine committed
354
355
356
357
358
359
		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
	request := api.PullRequest{Name: args[0], Insecure: insecure}
Michael Yang's avatar
Michael Yang committed
407
	if err := client.Pull(cmd.Context(), &request, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
408
409
410
411
		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
	}

Michael Yang's avatar
Michael Yang committed
496
	ctx, cancel := context.WithCancel(cmd.Context())
497
498
499
500
501
502
503
504
505
506
	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
	fn := func(response api.GenerateResponse) error {
Michael Yang's avatar
Michael Yang committed
511
		p.StopAndClear()
512

Patrick Devine's avatar
Patrick Devine committed
513
		latest = response
514

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

526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
					// 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 {
545
			fmt.Printf("%s%s", wordBuffer, response.Response)
546
547
548
			if len(wordBuffer) > 0 {
				wordBuffer = ""
			}
549
550
		}

Patrick Devine's avatar
Patrick Devine committed
551
552
		return nil
	}
553

Michael Yang's avatar
Michael Yang committed
554
555
556
557
558
559
560
561
562
563
564
	request := api.GenerateRequest{
		Model:    opts.Model,
		Prompt:   opts.Prompt,
		Context:  generateContext,
		Format:   opts.Format,
		System:   opts.System,
		Template: opts.Template,
		Options:  opts.Options,
	}

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

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

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

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

Michael Yang's avatar
Michael Yang committed
588
	cmd.SetContext(context.WithValue(cmd.Context(), generateContextKey("context"), latest.Context))
589
	return nil
Michael Yang's avatar
Michael Yang committed
590
591
}

592
593
594
595
596
597
598
599
600
type MultilineState int

const (
	MultilineNone MultilineState = iota
	MultilinePrompt
	MultilineSystem
	MultilineTemplate
)

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

Michael Yang's avatar
Michael Yang committed
611
	usage := func() {
Patrick Devine's avatar
Patrick Devine committed
612
613
614
615
616
617
618
619
620
621
622
623
		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:")
624
625
626
627
628
629
630
631
632
633
634
		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
635
636
637
638
639
640
641
642
643
644
645
		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
646
647
	}

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

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

674
675
676
	fmt.Print(readline.StartBracketedPaste)
	defer fmt.Printf(readline.EndBracketedPaste)

677
	var multiline MultilineState
678
	var prompt string
679

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

691
			scanner.Prompt.UseAlt = false
692
			prompt = ""
693

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

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

			if !found {
707
708
				continue
			}
709

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

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

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

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

909
			prompt = ""
Michael Yang's avatar
Michael Yang committed
910
911
		}
	}
Bruce MacDonald's avatar
Bruce MacDonald committed
912
913
}

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

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

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

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

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

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

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

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

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

979
		err = os.WriteFile(pubKeyPath, pubKeyData, 0o644)
980
981
982
983
984
985
986
987
988
		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
989
func startMacApp(ctx context.Context, client *api.Client) error {
Bruce MacDonald's avatar
Bruce MacDonald committed
990
991
992
993
994
	exe, err := os.Executable()
	if err != nil {
		return err
	}
	link, err := os.Readlink(exe)
Bruce MacDonald's avatar
Bruce MacDonald committed
995
996
997
	if err != nil {
		return err
	}
Bruce MacDonald's avatar
Bruce MacDonald committed
998
999
1000
	if !strings.Contains(link, "Ollama.app") {
		return fmt.Errorf("could not find ollama app")
	}
Bruce MacDonald's avatar
Bruce MacDonald committed
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
	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
1013
			if err := client.Heartbeat(ctx); err == nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
1014
1015
1016
1017
1018
1019
				return nil // server has started
			}
		}
	}
}

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

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

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

	cobra.EnableCommandSorting = false

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

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

Patrick Devine's avatar
Patrick Devine committed
1066
1067
1068
	showCmd := &cobra.Command{
		Use:     "show MODEL",
		Short:   "Show information for a model",
Michael Yang's avatar
Michael Yang committed
1069
		Args:    cobra.ExactArgs(1),
Patrick Devine's avatar
Patrick Devine committed
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
		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
1080
	runCmd := &cobra.Command{
1081
1082
1083
1084
1085
		Use:     "run MODEL [PROMPT]",
		Short:   "Run a model",
		Args:    cobra.MinimumNArgs(1),
		PreRunE: checkServerHeartbeat,
		RunE:    RunHandler,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1086
1087
	}

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

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

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

1109
1110
	pullCmd.Flags().Bool("insecure", false, "Use an insecure registry")

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

1119
1120
	pushCmd.Flags().Bool("insecure", false, "Use an insecure registry")

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

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

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

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

	return rootCmd
}