cmd.go 38.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
	"bufio"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
5
	"context"
6
7
	"crypto/ed25519"
	"crypto/rand"
8
	"encoding/json"
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
	"log"
14
	"math"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
15
	"net"
16
	"net/http"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
17
	"os"
18
	"os/signal"
19
	"path/filepath"
20
	"runtime"
21
	"slices"
22
	"sort"
Michael Yang's avatar
Michael Yang committed
23
	"strconv"
Michael Yang's avatar
Michael Yang committed
24
	"strings"
25
	"sync/atomic"
26
	"syscall"
Michael Yang's avatar
Michael Yang committed
27
	"time"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
28

29
	"github.com/containerd/console"
30
	"github.com/mattn/go-runewidth"
Patrick Devine's avatar
Patrick Devine committed
31
	"github.com/olekukonko/tablewriter"
Michael Yang's avatar
Michael Yang committed
32
	"github.com/spf13/cobra"
33
	"golang.org/x/crypto/ssh"
34
	"golang.org/x/sync/errgroup"
35
	"golang.org/x/term"
Michael Yang's avatar
Michael Yang committed
36

37
	"github.com/ollama/ollama/api"
38
	"github.com/ollama/ollama/envconfig"
39
	"github.com/ollama/ollama/format"
40
	"github.com/ollama/ollama/parser"
41
	"github.com/ollama/ollama/progress"
42
	"github.com/ollama/ollama/readline"
Jesse Gross's avatar
Jesse Gross committed
43
	"github.com/ollama/ollama/runner"
44
	"github.com/ollama/ollama/server"
45
	"github.com/ollama/ollama/types/model"
46
	"github.com/ollama/ollama/types/syncmap"
47
	"github.com/ollama/ollama/version"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
48
49
)

50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
// ensureThinkingSupport emits a warning if the model does not advertise thinking support
func ensureThinkingSupport(ctx context.Context, client *api.Client, name string) {
	if name == "" {
		return
	}
	resp, err := client.Show(ctx, &api.ShowRequest{Model: name})
	if err != nil {
		return
	}
	for _, cap := range resp.Capabilities {
		if cap == model.CapabilityThinking {
			return
		}
	}
	fmt.Fprintf(os.Stderr, "warning: model %q does not support thinking output\n", name)
}

67
var errModelfileNotFound = errors.New("specified Modelfile wasn't found")
68
69

func getModelfileName(cmd *cobra.Command) (string, error) {
70
	filename, _ := cmd.Flags().GetString("file")
71
72
73
74
75
76

	if filename == "" {
		filename = "Modelfile"
	}

	absName, err := filepath.Abs(filename)
77
	if err != nil {
78
		return "", err
79
80
	}

81
	_, err = os.Stat(absName)
82
	if err != nil {
83
		return "", err
84
	}
85

86
87
88
89
	return absName, nil
}

func CreateHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
90
91
92
	p := progress.NewProgress(os.Stderr)
	defer p.Stop()

93
94
95
96
97
98
99
100
101
102
	var reader io.Reader

	filename, err := getModelfileName(cmd)
	if os.IsNotExist(err) {
		if filename == "" {
			reader = strings.NewReader("FROM .\n")
		} else {
			return errModelfileNotFound
		}
	} else if err != nil {
Michael Yang's avatar
Michael Yang committed
103
		return err
104
105
106
107
108
109
110
111
	} else {
		f, err := os.Open(filename)
		if err != nil {
			return err
		}

		reader = f
		defer f.Close()
Michael Yang's avatar
Michael Yang committed
112
113
	}

114
	modelfile, err := parser.ParseFile(reader)
Michael Yang's avatar
Michael Yang committed
115
116
117
118
	if err != nil {
		return err
	}

119
120
121
122
	status := "gathering model components"
	spinner := progress.NewSpinner(status)
	p.Add(status, spinner)

123
	req, err := modelfile.CreateRequest(filepath.Dir(filename))
Michael Yang's avatar
Michael Yang committed
124
125
126
	if err != nil {
		return err
	}
127
	spinner.Stop()
Michael Yang's avatar
Michael Yang committed
128

129
	req.Model = args[0]
130
131
132
133
	quantize, _ := cmd.Flags().GetString("quantize")
	if quantize != "" {
		req.Quantize = quantize
	}
134

135
136
137
138
139
	client, err := api.ClientFromEnvironment()
	if err != nil {
		return err
	}

140
141
142
143
144
145
	var g errgroup.Group
	g.SetLimit(max(runtime.GOMAXPROCS(0)-1, 1))

	files := syncmap.NewSyncMap[string, string]()
	for f, digest := range req.Files {
		g.Go(func() error {
146
			if _, err := createBlob(cmd, client, f, digest, p); err != nil {
Michael Yang's avatar
Michael Yang committed
147
148
				return err
			}
149
150
151
152
153
154
155

			// TODO: this is incorrect since the file might be in a subdirectory
			//       instead this should take the path relative to the model directory
			//       but the current implementation does not allow this
			files.Store(filepath.Base(f), digest)
			return nil
		})
156
	}
Michael Yang's avatar
Michael Yang committed
157

158
159
160
	adapters := syncmap.NewSyncMap[string, string]()
	for f, digest := range req.Adapters {
		g.Go(func() error {
161
			if _, err := createBlob(cmd, client, f, digest, p); err != nil {
Michael Yang's avatar
Michael Yang committed
162
163
				return err
			}
164
165
166
167
168

			// TODO: same here
			adapters.Store(filepath.Base(f), digest)
			return nil
		})
Michael Yang's avatar
Michael Yang committed
169
	}
Michael Yang's avatar
Michael Yang committed
170

171
172
173
174
175
176
177
	if err := g.Wait(); err != nil {
		return err
	}

	req.Files = files.Items()
	req.Adapters = adapters.Items()

Michael Yang's avatar
Michael Yang committed
178
	bars := make(map[string]*progress.Bar)
179
	fn := func(resp api.ProgressResponse) error {
Michael Yang's avatar
Michael Yang committed
180
181
182
		if resp.Digest != "" {
			bar, ok := bars[resp.Digest]
			if !ok {
183
184
185
186
187
				msg := resp.Status
				if msg == "" {
					msg = fmt.Sprintf("pulling %s...", resp.Digest[7:19])
				}
				bar = progress.NewBar(msg, resp.Total, resp.Completed)
Michael Yang's avatar
Michael Yang committed
188
189
190
191
192
193
194
195
196
197
198
199
200
				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)
		}

201
202
203
		return nil
	}

204
	if err := client.Create(cmd.Context(), req, fn); err != nil {
205
206
207
		if strings.Contains(err.Error(), "path or Modelfile are required") {
			return fmt.Errorf("the ollama server must be updated to use `ollama create` with this client")
		}
208
209
210
211
212
213
		return err
	}

	return nil
}

214
215
func createBlob(cmd *cobra.Command, client *api.Client, path string, digest string, p *progress.Progress) (string, error) {
	realPath, err := filepath.EvalSymlinks(path)
Michael Yang's avatar
Michael Yang committed
216
217
218
219
	if err != nil {
		return "", err
	}

220
	bin, err := os.Open(realPath)
221
222
223
224
225
	if err != nil {
		return "", err
	}
	defer bin.Close()

226
227
228
229
230
231
232
233
	// Get file info to retrieve the size
	fileInfo, err := bin.Stat()
	if err != nil {
		return "", err
	}
	fileSize := fileInfo.Size()

	var pw progressWriter
234
235
236
237
	status := fmt.Sprintf("copying file %s 0%%", digest)
	spinner := progress.NewSpinner(status)
	p.Add(status, spinner)
	defer spinner.Stop()
238
239
240
241
242
243
244
245
246
247

	done := make(chan struct{})
	defer close(done)

	go func() {
		ticker := time.NewTicker(60 * time.Millisecond)
		defer ticker.Stop()
		for {
			select {
			case <-ticker.C:
248
				spinner.SetMessage(fmt.Sprintf("copying file %s %d%%", digest, int(100*pw.n.Load()/fileSize)))
249
			case <-done:
250
				spinner.SetMessage(fmt.Sprintf("copying file %s 100%%", digest))
251
252
253
254
255
				return
			}
		}
	}()

256
	if err := client.CreateBlob(cmd.Context(), digest, io.TeeReader(bin, &pw)); err != nil {
257
258
259
260
261
		return "", err
	}
	return digest, nil
}

262
263
264
265
266
267
268
269
270
type progressWriter struct {
	n atomic.Int64
}

func (w *progressWriter) Write(p []byte) (n int, err error) {
	w.n.Add(int64(len(p)))
	return len(p), nil
}

Patrick Devine's avatar
Patrick Devine committed
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
func loadOrUnloadModel(cmd *cobra.Command, opts *runOptions) error {
	p := progress.NewProgress(os.Stderr)
	defer p.StopAndClear()

	spinner := progress.NewSpinner("")
	p.Add("", spinner)

	client, err := api.ClientFromEnvironment()
	if err != nil {
		return err
	}

	req := &api.GenerateRequest{
		Model:     opts.Model,
		KeepAlive: opts.KeepAlive,
286
287
288

		// pass Think here so we fail before getting to the chat prompt if the model doesn't support it
		Think: opts.Think,
Patrick Devine's avatar
Patrick Devine committed
289
290
291
292
293
294
295
296
297
298
299
300
301
302
	}

	return client.Generate(cmd.Context(), req, func(api.GenerateResponse) error { return nil })
}

func StopHandler(cmd *cobra.Command, args []string) error {
	opts := &runOptions{
		Model:     args[0],
		KeepAlive: &api.Duration{Duration: 0},
	}
	if err := loadOrUnloadModel(cmd, opts); err != nil {
		if strings.Contains(err.Error(), "not found") {
			return fmt.Errorf("couldn't find model \"%s\" to stop", args[0])
		}
303
		return err
Patrick Devine's avatar
Patrick Devine committed
304
305
306
307
	}
	return nil
}

308
func RunHandler(cmd *cobra.Command, args []string) error {
309
310
311
	interactive := true

	opts := runOptions{
312
313
		Model:    args[0],
		WordWrap: os.Getenv("TERM") == "xterm-256color",
314
		Options:  map[string]any{},
315
316
317
318
319
320
321
322
	}

	format, err := cmd.Flags().GetString("format")
	if err != nil {
		return err
	}
	opts.Format = format

323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
	thinkFlag := cmd.Flags().Lookup("think")
	if thinkFlag.Changed {
		think, err := cmd.Flags().GetBool("think")
		if err != nil {
			return err
		}
		opts.Think = &think
	} else {
		opts.Think = nil
	}
	hidethinking, err := cmd.Flags().GetBool("hidethinking")
	if err != nil {
		return err
	}
	opts.HideThinking = hidethinking

339
340
341
342
343
344
345
346
347
348
349
350
	keepAlive, err := cmd.Flags().GetString("keepalive")
	if err != nil {
		return err
	}
	if keepAlive != "" {
		d, err := time.ParseDuration(keepAlive)
		if err != nil {
			return err
		}
		opts.KeepAlive = &api.Duration{Duration: d}
	}

351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
	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
	}
367
368
369
370
	// Be quiet if we're redirecting to a pipe or file
	if !term.IsTerminal(int(os.Stdout.Fd())) {
		interactive = false
	}
371
372
373
374
375
376
377

	nowrap, err := cmd.Flags().GetBool("nowordwrap")
	if err != nil {
		return err
	}
	opts.WordWrap = !nowrap

378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
	// Fill out the rest of the options based on information about the
	// model.
	client, err := api.ClientFromEnvironment()
	if err != nil {
		return err
	}

	name := args[0]
	info, err := func() (*api.ShowResponse, error) {
		showReq := &api.ShowRequest{Name: name}
		info, err := client.Show(cmd.Context(), showReq)
		var se api.StatusError
		if errors.As(err, &se) && se.StatusCode == http.StatusNotFound {
			if err := PullHandler(cmd, []string{name}); err != nil {
				return nil, err
			}
			return client.Show(cmd.Context(), &api.ShowRequest{Name: name})
		}
		return info, err
	}()
	if err != nil {
		return err
400
401
	}

402
403
404
405
406
	opts.Think, err = inferThinkingOption(&info.Capabilities, &opts, thinkFlag.Changed)
	if err != nil {
		return err
	}

407
408
409
410
411
	opts.MultiModal = slices.Contains(info.Capabilities, model.CapabilityVision)

	// TODO: remove the projector info and vision info checks below,
	// these are left in for backwards compatibility with older servers
	// that don't have the capabilities field in the model info
412
413
414
415
416
417
418
419
420
421
	if len(info.ProjectorInfo) != 0 {
		opts.MultiModal = true
	}
	for k := range info.ModelInfo {
		if strings.Contains(k, ".vision.") {
			opts.MultiModal = true
			break
		}
	}

422
423
424
	opts.ParentModel = info.Details.ParentModel

	if interactive {
Patrick Devine's avatar
Patrick Devine committed
425
		if err := loadOrUnloadModel(cmd, &opts); err != nil {
Michael Yang's avatar
Michael Yang committed
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
			return err
		}

		for _, msg := range info.Messages {
			switch msg.Role {
			case "user":
				fmt.Printf(">>> %s\n", msg.Content)
			case "assistant":
				state := &displayResponseState{}
				displayResponse(msg.Content, opts.WordWrap, state)
				fmt.Println()
				fmt.Println()
			}
		}

441
442
443
		return generateInteractive(cmd, opts)
	}
	return generate(cmd, opts)
Bruce MacDonald's avatar
Bruce MacDonald committed
444
445
}

446
func PushHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
447
	client, err := api.ClientFromEnvironment()
448
449
450
	if err != nil {
		return err
	}
451

452
453
454
455
456
	insecure, err := cmd.Flags().GetBool("insecure")
	if err != nil {
		return err
	}

Michael Yang's avatar
Michael Yang committed
457
458
459
460
	p := progress.NewProgress(os.Stderr)
	defer p.Stop()

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

464
	fn := func(resp api.ProgressResponse) error {
Michael Yang's avatar
Michael Yang committed
465
		if resp.Digest != "" {
466
467
468
			if spinner != nil {
				spinner.Stop()
			}
Michael Yang's avatar
Michael Yang committed
469
470
471

			bar, ok := bars[resp.Digest]
			if !ok {
472
				bar = progress.NewBar(fmt.Sprintf("pushing %s...", resp.Digest[7:19]), resp.Total, resp.Completed)
Michael Yang's avatar
Michael Yang committed
473
474
475
476
477
478
				bars[resp.Digest] = bar
				p.Add(resp.Digest, bar)
			}

			bar.Set(resp.Completed)
		} else if status != resp.Status {
479
480
481
			if spinner != nil {
				spinner.Stop()
			}
Michael Yang's avatar
Michael Yang committed
482
483
484
485
486
487

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

488
489
490
		return nil
	}

Michael Yang's avatar
Michael Yang committed
491
	request := api.PushRequest{Name: args[0], Insecure: insecure}
492
493

	n := model.ParseName(args[0])
Michael Yang's avatar
Michael Yang committed
494
	if err := client.Push(cmd.Context(), &request, fn); err != nil {
495
496
497
498
499
500
		if spinner != nil {
			spinner.Stop()
		}
		if strings.Contains(err.Error(), "access denied") {
			return errors.New("you are not authorized to push to this namespace, create the model under a namespace you own")
		}
Michael Yang's avatar
Michael Yang committed
501
502
503
		return err
	}

504
	p.Stop()
505
	spinner.Stop()
506
507
508
509
510
511
512
513

	destination := n.String()
	if strings.HasSuffix(n.Host, ".ollama.ai") || strings.HasSuffix(n.Host, ".ollama.com") {
		destination = "https://ollama.com/" + strings.TrimSuffix(n.DisplayShortest(), ":latest")
	}
	fmt.Printf("\nYou can find your model at:\n\n")
	fmt.Printf("\t%s\n", destination)

Michael Yang's avatar
Michael Yang committed
514
	return nil
515
516
}

517
func ListHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
518
	client, err := api.ClientFromEnvironment()
519
520
521
	if err != nil {
		return err
	}
Patrick Devine's avatar
Patrick Devine committed
522

Michael Yang's avatar
Michael Yang committed
523
	models, err := client.List(cmd.Context())
Patrick Devine's avatar
Patrick Devine committed
524
525
526
527
528
529
530
	if err != nil {
		return err
	}

	var data [][]string

	for _, m := range models.Models {
531
		if len(args) == 0 || strings.HasPrefix(strings.ToLower(m.Name), strings.ToLower(args[0])) {
532
			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
533
		}
Patrick Devine's avatar
Patrick Devine committed
534
535
536
	}

	table := tablewriter.NewWriter(os.Stdout)
Patrick Devine's avatar
Patrick Devine committed
537
	table.SetHeader([]string{"NAME", "ID", "SIZE", "MODIFIED"})
Patrick Devine's avatar
Patrick Devine committed
538
539
540
541
542
	table.SetHeaderAlignment(tablewriter.ALIGN_LEFT)
	table.SetAlignment(tablewriter.ALIGN_LEFT)
	table.SetHeaderLine(false)
	table.SetBorder(false)
	table.SetNoWhiteSpace(true)
Michael Yang's avatar
Michael Yang committed
543
	table.SetTablePadding("    ")
Patrick Devine's avatar
Patrick Devine committed
544
545
546
547
548
549
	table.AppendBulk(data)
	table.Render()

	return nil
}

550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
func ListRunningHandler(cmd *cobra.Command, args []string) error {
	client, err := api.ClientFromEnvironment()
	if err != nil {
		return err
	}

	models, err := client.ListRunning(cmd.Context())
	if err != nil {
		return err
	}

	var data [][]string

	for _, m := range models.Models {
		if len(args) == 0 || strings.HasPrefix(m.Name, args[0]) {
			var procStr string
			switch {
			case m.SizeVRAM == 0:
				procStr = "100% CPU"
			case m.SizeVRAM == m.Size:
				procStr = "100% GPU"
			case m.SizeVRAM > m.Size || m.Size == 0:
				procStr = "Unknown"
			default:
				sizeCPU := m.Size - m.SizeVRAM
				cpuPercent := math.Round(float64(sizeCPU) / float64(m.Size) * 100)
				procStr = fmt.Sprintf("%d%%/%d%% CPU/GPU", int(cpuPercent), int(100-cpuPercent))
			}
Patrick Devine's avatar
Patrick Devine committed
578
579
580
581
582
583
584
585
586

			var until string
			delta := time.Since(m.ExpiresAt)
			if delta > 0 {
				until = "Stopping..."
			} else {
				until = format.HumanTime(m.ExpiresAt, "Never")
			}
			data = append(data, []string{m.Name, m.Digest[:12], format.HumanBytes(m.Size), procStr, until})
587
588
589
590
591
592
593
594
595
596
		}
	}

	table := tablewriter.NewWriter(os.Stdout)
	table.SetHeader([]string{"NAME", "ID", "SIZE", "PROCESSOR", "UNTIL"})
	table.SetHeaderAlignment(tablewriter.ALIGN_LEFT)
	table.SetAlignment(tablewriter.ALIGN_LEFT)
	table.SetHeaderLine(false)
	table.SetBorder(false)
	table.SetNoWhiteSpace(true)
Michael Yang's avatar
Michael Yang committed
597
	table.SetTablePadding("    ")
598
599
600
601
602
603
	table.AppendBulk(data)
	table.Render()

	return nil
}

604
func DeleteHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
605
	client, err := api.ClientFromEnvironment()
606
607
608
	if err != nil {
		return err
	}
609

610
611
612
613
614
615
616
617
618
619
620
	// Unload the model if it's running before deletion
	opts := &runOptions{
		Model:     args[0],
		KeepAlive: &api.Duration{Duration: 0},
	}
	if err := loadOrUnloadModel(cmd, opts); err != nil {
		if !strings.Contains(err.Error(), "not found") {
			return fmt.Errorf("unable to stop existing running model \"%s\": %s", args[0], err)
		}
	}

621
622
	for _, name := range args {
		req := api.DeleteRequest{Name: name}
Michael Yang's avatar
Michael Yang committed
623
		if err := client.Delete(cmd.Context(), &req); err != nil {
624
625
626
			return err
		}
		fmt.Printf("deleted '%s'\n", name)
627
628
629
630
	}
	return nil
}

Patrick Devine's avatar
Patrick Devine committed
631
func ShowHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
632
	client, err := api.ClientFromEnvironment()
Patrick Devine's avatar
Patrick Devine committed
633
634
635
636
637
638
639
640
641
	if err != nil {
		return err
	}

	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")
642
	verbose, errVerbose := cmd.Flags().GetBool("verbose")
Patrick Devine's avatar
Patrick Devine committed
643

644
	for _, boolErr := range []error{errLicense, errModelfile, errParams, errSystem, errTemplate, errVerbose} {
Patrick Devine's avatar
Patrick Devine committed
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
		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 {
679
		return errors.New("only one of '--license', '--modelfile', '--parameters', '--system', or '--template' can be specified")
680
681
	}

682
	req := api.ShowRequest{Name: args[0], Verbose: verbose}
683
684
685
686
	resp, err := client.Show(cmd.Context(), &req)
	if err != nil {
		return err
	}
687

688
	if flagsSet == 1 {
689
690
691
692
693
694
695
696
		switch showType {
		case "license":
			fmt.Println(resp.License)
		case "modelfile":
			fmt.Println(resp.Modelfile)
		case "parameters":
			fmt.Println(resp.Parameters)
		case "system":
697
			fmt.Print(resp.System)
698
		case "template":
699
			fmt.Print(resp.Template)
700
701
702
		}

		return nil
Patrick Devine's avatar
Patrick Devine committed
703
704
	}

705
	return showInfo(resp, verbose, os.Stdout)
706
707
}

708
func showInfo(resp *api.ShowResponse, verbose bool, w io.Writer) error {
Michael Yang's avatar
Michael Yang committed
709
710
711
712
713
714
715
	tableRender := func(header string, rows func() [][]string) {
		fmt.Fprintln(w, " ", header)
		table := tablewriter.NewWriter(w)
		table.SetAlignment(tablewriter.ALIGN_LEFT)
		table.SetBorder(false)
		table.SetNoWhiteSpace(true)
		table.SetTablePadding("    ")
716

Michael Yang's avatar
Michael Yang committed
717
718
719
		switch header {
		case "Template", "System", "License":
			table.SetColWidth(100)
720
721
		}

Michael Yang's avatar
Michael Yang committed
722
723
724
		table.AppendBulk(rows())
		table.Render()
		fmt.Fprintln(w)
Patrick Devine's avatar
Patrick Devine committed
725
726
	}

Michael Yang's avatar
Michael Yang committed
727
728
729
730
731
732
733
734
735
736
737
738
739
740
	tableRender("Model", func() (rows [][]string) {
		if resp.ModelInfo != nil {
			arch := resp.ModelInfo["general.architecture"].(string)
			rows = append(rows, []string{"", "architecture", arch})
			rows = append(rows, []string{"", "parameters", format.HumanNumber(uint64(resp.ModelInfo["general.parameter_count"].(float64)))})
			rows = append(rows, []string{"", "context length", strconv.FormatFloat(resp.ModelInfo[fmt.Sprintf("%s.context_length", arch)].(float64), 'f', -1, 64)})
			rows = append(rows, []string{"", "embedding length", strconv.FormatFloat(resp.ModelInfo[fmt.Sprintf("%s.embedding_length", arch)].(float64), 'f', -1, 64)})
		} else {
			rows = append(rows, []string{"", "architecture", resp.Details.Family})
			rows = append(rows, []string{"", "parameters", resp.Details.ParameterSize})
		}
		rows = append(rows, []string{"", "quantization", resp.Details.QuantizationLevel})
		return
	})
741

742
743
744
745
746
747
748
749
750
	if len(resp.Capabilities) > 0 {
		tableRender("Capabilities", func() (rows [][]string) {
			for _, capability := range resp.Capabilities {
				rows = append(rows, []string{"", capability.String()})
			}
			return
		})
	}

Michael Yang's avatar
Michael Yang committed
751
752
753
754
755
756
757
758
759
	if resp.ProjectorInfo != nil {
		tableRender("Projector", func() (rows [][]string) {
			arch := resp.ProjectorInfo["general.architecture"].(string)
			rows = append(rows, []string{"", "architecture", arch})
			rows = append(rows, []string{"", "parameters", format.HumanNumber(uint64(resp.ProjectorInfo["general.parameter_count"].(float64)))})
			rows = append(rows, []string{"", "embedding length", strconv.FormatFloat(resp.ProjectorInfo[fmt.Sprintf("%s.vision.embedding_length", arch)].(float64), 'f', -1, 64)})
			rows = append(rows, []string{"", "dimensions", strconv.FormatFloat(resp.ProjectorInfo[fmt.Sprintf("%s.vision.projection_dim", arch)].(float64), 'f', -1, 64)})
			return
		})
760
761
	}

Michael Yang's avatar
Michael Yang committed
762
763
764
765
766
767
768
769
770
771
	if resp.Parameters != "" {
		tableRender("Parameters", func() (rows [][]string) {
			scanner := bufio.NewScanner(strings.NewReader(resp.Parameters))
			for scanner.Scan() {
				if text := scanner.Text(); text != "" {
					rows = append(rows, append([]string{""}, strings.Fields(text)...))
				}
			}
			return
		})
772
773
	}

774
775
776
777
778
779
780
781
782
783
784
	if resp.ModelInfo != nil && verbose {
		tableRender("Metadata", func() (rows [][]string) {
			keys := make([]string, 0, len(resp.ModelInfo))
			for k := range resp.ModelInfo {
				keys = append(keys, k)
			}
			sort.Strings(keys)

			for _, k := range keys {
				var v string
				switch vData := resp.ModelInfo[k].(type) {
785
786
				case bool:
					v = fmt.Sprintf("%t", vData)
787
788
789
790
791
				case string:
					v = vData
				case float64:
					v = fmt.Sprintf("%g", vData)
				case []any:
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
					targetWidth := 10 // Small width where we are displaying the data in a column

					var itemsToShow int
					totalWidth := 1 // Start with 1 for opening bracket

					// Find how many we can fit
					for i := range vData {
						itemStr := fmt.Sprintf("%v", vData[i])
						width := runewidth.StringWidth(itemStr)

						// Add separator width (", ") for all items except the first
						if i > 0 {
							width += 2
						}

						// Check if adding this item would exceed our width limit
						if totalWidth+width > targetWidth && i > 0 {
							break
						}

						totalWidth += width
						itemsToShow++
					}

					// Format the output
					if itemsToShow < len(vData) {
						v = fmt.Sprintf("%v", vData[:itemsToShow])
						v = strings.TrimSuffix(v, "]")
						v += fmt.Sprintf(" ...+%d more]", len(vData)-itemsToShow)
					} else {
						v = fmt.Sprintf("%v", vData)
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
					}
				default:
					v = fmt.Sprintf("%T", vData)
				}
				rows = append(rows, []string{"", k, v})
			}
			return
		})
	}

	if len(resp.Tensors) > 0 && verbose {
		tableRender("Tensors", func() (rows [][]string) {
			for _, t := range resp.Tensors {
				rows = append(rows, []string{"", t.Name, t.Type, fmt.Sprint(t.Shape)})
			}
			return
		})
	}

Michael Yang's avatar
Michael Yang committed
842
843
	head := func(s string, n int) (rows [][]string) {
		scanner := bufio.NewScanner(strings.NewReader(s))
844
845
846
847
848
		count := 0
		for scanner.Scan() {
			text := strings.TrimSpace(scanner.Text())
			if text == "" {
				continue
849
			}
850
851
852
853
854
855
856
			count++
			if n < 0 || count <= n {
				rows = append(rows, []string{"", text})
			}
		}
		if n >= 0 && count > n {
			rows = append(rows, []string{"", "..."})
857
		}
Michael Yang's avatar
Michael Yang committed
858
		return
859
860
	}

Michael Yang's avatar
Michael Yang committed
861
862
863
864
865
	if resp.System != "" {
		tableRender("System", func() [][]string {
			return head(resp.System, 2)
		})
	}
866

Michael Yang's avatar
Michael Yang committed
867
868
869
870
	if resp.License != "" {
		tableRender("License", func() [][]string {
			return head(resp.License, 2)
		})
871
	}
Michael Yang's avatar
Michael Yang committed
872
873

	return nil
874
875
}

Patrick Devine's avatar
Patrick Devine committed
876
func CopyHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
877
	client, err := api.ClientFromEnvironment()
878
879
880
	if err != nil {
		return err
	}
Patrick Devine's avatar
Patrick Devine committed
881
882

	req := api.CopyRequest{Source: args[0], Destination: args[1]}
Michael Yang's avatar
Michael Yang committed
883
	if err := client.Copy(cmd.Context(), &req); err != nil {
Patrick Devine's avatar
Patrick Devine committed
884
885
886
887
888
889
		return err
	}
	fmt.Printf("copied '%s' to '%s'\n", args[0], args[1])
	return nil
}

890
func PullHandler(cmd *cobra.Command, args []string) error {
891
892
893
894
895
	insecure, err := cmd.Flags().GetBool("insecure")
	if err != nil {
		return err
	}

Michael Yang's avatar
Michael Yang committed
896
	client, err := api.ClientFromEnvironment()
897
898
899
	if err != nil {
		return err
	}
900

Michael Yang's avatar
Michael Yang committed
901
902
903
904
905
	p := progress.NewProgress(os.Stderr)
	defer p.Stop()

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

906
907
	var status string
	var spinner *progress.Spinner
Michael Yang's avatar
Michael Yang committed
908

909
	fn := func(resp api.ProgressResponse) error {
Michael Yang's avatar
Michael Yang committed
910
		if resp.Digest != "" {
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
			if resp.Completed == 0 {
				// This is the initial status update for the
				// layer, which the server sends before
				// beginning the download, for clients to
				// compute total size and prepare for
				// downloads, if needed.
				//
				// Skipping this here to avoid showing a 0%
				// progress bar, which *should* clue the user
				// into the fact that many things are being
				// downloaded and that the current active
				// download is not that last. However, in rare
				// cases it seems to be triggering to some, and
				// it isn't worth explaining, so just ignore
				// and regress to the old UI that keeps giving
				// you the "But wait, there is more!" after
				// each "100% done" bar, which is "better."
				return nil
			}

931
932
933
			if spinner != nil {
				spinner.Stop()
			}
Michael Yang's avatar
Michael Yang committed
934
935
936

			bar, ok := bars[resp.Digest]
			if !ok {
937
938
939
940
941
942
				name, isDigest := strings.CutPrefix(resp.Digest, "sha256:")
				name = strings.TrimSpace(name)
				if isDigest {
					name = name[:min(12, len(name))]
				}
				bar = progress.NewBar(fmt.Sprintf("pulling %s:", name), resp.Total, resp.Completed)
Michael Yang's avatar
Michael Yang committed
943
944
945
946
947
948
				bars[resp.Digest] = bar
				p.Add(resp.Digest, bar)
			}

			bar.Set(resp.Completed)
		} else if status != resp.Status {
949
950
951
			if spinner != nil {
				spinner.Stop()
			}
Michael Yang's avatar
Michael Yang committed
952
953
954
955
956
957

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

958
959
		return nil
	}
960

Michael Yang's avatar
Michael Yang committed
961
	request := api.PullRequest{Name: args[0], Insecure: insecure}
962
	return client.Pull(cmd.Context(), &request, fn)
Michael Yang's avatar
Michael Yang committed
963
964
}

965
966
type generateContextKey string

967
type runOptions struct {
968
969
970
971
972
973
974
975
976
977
978
979
980
	Model        string
	ParentModel  string
	Prompt       string
	Messages     []api.Message
	WordWrap     bool
	Format       string
	System       string
	Images       []api.ImageData
	Options      map[string]any
	MultiModal   bool
	KeepAlive    *api.Duration
	Think        *bool
	HideThinking bool
981
982
}

983
984
985
986
987
988
989
990
991
type displayResponseState struct {
	lineLength int
	wordBuffer string
}

func displayResponse(content string, wordWrap bool, state *displayResponseState) {
	termWidth, _, _ := term.GetSize(int(os.Stdout.Fd()))
	if wordWrap && termWidth >= 10 {
		for _, ch := range content {
Josh Yan's avatar
Josh Yan committed
992
993
			if state.lineLength+1 > termWidth-5 {
				if runewidth.StringWidth(state.wordBuffer) > termWidth-10 {
994
995
996
997
998
999
1000
					fmt.Printf("%s%c", state.wordBuffer, ch)
					state.wordBuffer = ""
					state.lineLength = 0
					continue
				}

				// backtrack the length of the last word and clear to the end of the line
1001
1002
				a := runewidth.StringWidth(state.wordBuffer)
				if a > 0 {
1003
					fmt.Printf("\x1b[%dD", a)
1004
1005
				}
				fmt.Printf("\x1b[K\n")
1006
				fmt.Printf("%s%c", state.wordBuffer, ch)
1007
1008
1009
				chWidth := runewidth.RuneWidth(ch)

				state.lineLength = runewidth.StringWidth(state.wordBuffer) + chWidth
1010
1011
			} else {
				fmt.Print(string(ch))
1012
1013
1014
1015
				state.lineLength += runewidth.RuneWidth(ch)
				if runewidth.RuneWidth(ch) >= 2 {
					state.wordBuffer = ""
					continue
Josh Yan's avatar
Josh Yan committed
1016
				}
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035

				switch ch {
				case ' ':
					state.wordBuffer = ""
				case '\n':
					state.lineLength = 0
				default:
					state.wordBuffer += string(ch)
				}
			}
		}
	} else {
		fmt.Printf("%s%s", state.wordBuffer, content)
		if len(state.wordBuffer) > 0 {
			state.wordBuffer = ""
		}
	}
}

1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
func thinkingOutputOpeningText(plainText bool) string {
	text := "Thinking...\n"

	if plainText {
		return text
	}

	return readline.ColorGrey + readline.ColorBold + text + readline.ColorDefault + readline.ColorGrey
}

func thinkingOutputClosingText(plainText bool) string {
	text := "...done thinking.\n\n"

	if plainText {
		return text
	}

	return readline.ColorGrey + readline.ColorBold + text + readline.ColorDefault
}

1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
func chat(cmd *cobra.Command, opts runOptions) (*api.Message, error) {
	client, err := api.ClientFromEnvironment()
	if err != nil {
		return nil, err
	}

	p := progress.NewProgress(os.Stderr)
	defer p.StopAndClear()

	spinner := progress.NewSpinner("")
	p.Add("", spinner)

	cancelCtx, cancel := context.WithCancel(cmd.Context())
	defer cancel()

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

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

	var state *displayResponseState = &displayResponseState{}
	var latest api.ChatResponse
	var fullResponse strings.Builder
	var role string
1083
1084
	var thinkTagOpened bool = false
	var thinkTagClosed bool = false
1085
1086

	fn := func(response api.ChatResponse) error {
1087
1088
1089
		if response.Message.Content != "" || !opts.HideThinking {
			p.StopAndClear()
		}
1090
1091
1092
1093

		latest = response

		role = response.Message.Role
1094
1095
1096
1097
1098
1099
1100
1101
		if response.Message.Thinking != "" && !opts.HideThinking {
			if !thinkTagOpened {
				fmt.Print(thinkingOutputOpeningText(false))
				thinkTagOpened = true
			}
			displayResponse(response.Message.Thinking, opts.WordWrap, state)
		}

1102
		content := response.Message.Content
1103
1104
1105
1106
1107
1108
1109
1110
		if thinkTagOpened && !thinkTagClosed && content != "" {
			fmt.Print(thinkingOutputClosingText(false))
			thinkTagClosed = true
		}
		// purposefully not putting thinking blocks in the response, which would
		// only be needed if we later added tool calling to the cli (they get
		// filtered out anyway since current models don't expect them unless you're
		// about to finish some tool calls)
1111
1112
1113
1114
1115
1116
1117
		fullResponse.WriteString(content)

		displayResponse(content, opts.WordWrap, state)

		return nil
	}

1118
1119
1120
1121
	if opts.Format == "json" {
		opts.Format = `"` + opts.Format + `"`
	}

1122
1123
1124
	req := &api.ChatRequest{
		Model:    opts.Model,
		Messages: opts.Messages,
1125
		Format:   json.RawMessage(opts.Format),
1126
		Options:  opts.Options,
1127
		Think:    opts.Think,
1128
1129
	}

1130
1131
1132
1133
	if opts.KeepAlive != nil {
		req.KeepAlive = opts.KeepAlive
	}

1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
	if err := client.Chat(cancelCtx, req, fn); err != nil {
		if errors.Is(err, context.Canceled) {
			return nil, nil
		}
		return nil, err
	}

	if len(opts.Messages) > 0 {
		fmt.Println()
		fmt.Println()
	}

	verbose, err := cmd.Flags().GetBool("verbose")
	if err != nil {
		return nil, err
	}

	if verbose {
		latest.Summary()
	}

	return &api.Message{Role: role, Content: fullResponse.String()}, nil
}

func generate(cmd *cobra.Command, opts runOptions) error {
Michael Yang's avatar
Michael Yang committed
1159
	client, err := api.ClientFromEnvironment()
Patrick Devine's avatar
Patrick Devine committed
1160
	if err != nil {
1161
		return err
Patrick Devine's avatar
Patrick Devine committed
1162
	}
Michael Yang's avatar
Michael Yang committed
1163

Michael Yang's avatar
Michael Yang committed
1164
	p := progress.NewProgress(os.Stderr)
1165
	defer p.StopAndClear()
1166

Michael Yang's avatar
Michael Yang committed
1167
1168
1169
	spinner := progress.NewSpinner("")
	p.Add("", spinner)

1170
1171
1172
1173
1174
1175
1176
	var latest api.GenerateResponse

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

Michael Yang's avatar
Michael Yang committed
1177
	ctx, cancel := context.WithCancel(cmd.Context())
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
	defer cancel()

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

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

1188
	var state *displayResponseState = &displayResponseState{}
1189
1190
	var thinkTagOpened bool = false
	var thinkTagClosed bool = false
1191

1192
	plainText := !term.IsTerminal(int(os.Stdout.Fd()))
1193

1194
	fn := func(response api.GenerateResponse) error {
Patrick Devine's avatar
Patrick Devine committed
1195
		latest = response
1196
		content := response.Response
1197

1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
		if response.Response != "" || !opts.HideThinking {
			p.StopAndClear()
		}

		if response.Thinking != "" && !opts.HideThinking {
			if !thinkTagOpened {
				fmt.Print(thinkingOutputOpeningText(plainText))
				thinkTagOpened = true
			}
			displayResponse(response.Thinking, opts.WordWrap, state)
		}

		if thinkTagOpened && !thinkTagClosed && content != "" {
			fmt.Print(thinkingOutputClosingText(plainText))
			thinkTagClosed = true
		}

1215
		displayResponse(content, opts.WordWrap, state)
1216

Patrick Devine's avatar
Patrick Devine committed
1217
1218
		return nil
	}
1219

1220
1221
1222
1223
1224
1225
1226
	if opts.MultiModal {
		opts.Prompt, opts.Images, err = extractFileData(opts.Prompt)
		if err != nil {
			return err
		}
	}

1227
1228
1229
1230
	if opts.Format == "json" {
		opts.Format = `"` + opts.Format + `"`
	}

Michael Yang's avatar
Michael Yang committed
1231
	request := api.GenerateRequest{
1232
1233
1234
1235
		Model:     opts.Model,
		Prompt:    opts.Prompt,
		Context:   generateContext,
		Images:    opts.Images,
1236
		Format:    json.RawMessage(opts.Format),
1237
1238
1239
		System:    opts.System,
		Options:   opts.Options,
		KeepAlive: opts.KeepAlive,
1240
		Think:     opts.Think,
Michael Yang's avatar
Michael Yang committed
1241
1242
1243
	}

	if err := client.Generate(ctx, &request, fn); err != nil {
1244
		if errors.Is(err, context.Canceled) {
1245
			return nil
1246
		}
1247
		return err
Patrick Devine's avatar
Patrick Devine committed
1248
	}
1249

1250
	if opts.Prompt != "" {
Michael Yang's avatar
Michael Yang committed
1251
1252
		fmt.Println()
		fmt.Println()
Patrick Devine's avatar
Patrick Devine committed
1253
	}
1254

1255
1256
1257
1258
	if !latest.Done {
		return nil
	}

Patrick Devine's avatar
Patrick Devine committed
1259
1260
	verbose, err := cmd.Flags().GetBool("verbose")
	if err != nil {
1261
		return err
Patrick Devine's avatar
Patrick Devine committed
1262
	}
Michael Yang's avatar
Michael Yang committed
1263

Patrick Devine's avatar
Patrick Devine committed
1264
1265
	if verbose {
		latest.Summary()
Michael Yang's avatar
Michael Yang committed
1266
	}
Michael Yang's avatar
Michael Yang committed
1267

Patrick Devine's avatar
Patrick Devine committed
1268
1269
1270
	ctx = context.WithValue(cmd.Context(), generateContextKey("context"), latest.Context)
	cmd.SetContext(ctx)

1271
	return nil
Michael Yang's avatar
Michael Yang committed
1272
1273
}

1274
func RunServer(_ *cobra.Command, _ []string) error {
Michael Yang's avatar
Michael Yang committed
1275
	if err := initializeKeypair(); err != nil {
1276
1277
1278
		return err
	}

Michael Yang's avatar
host  
Michael Yang committed
1279
	ln, err := net.Listen("tcp", envconfig.Host().Host)
1280
1281
1282
	if err != nil {
		return err
	}
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1283

1284
1285
1286
1287
1288
1289
	err = server.Serve(ln)
	if errors.Is(err, http.ErrServerClosed) {
		return nil
	}

	return err
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1290
1291
}

1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
func initializeKeypair() error {
	home, err := os.UserHomeDir()
	if err != nil {
		return err
	}

	privKeyPath := filepath.Join(home, ".ollama", "id_ed25519")
	pubKeyPath := filepath.Join(home, ".ollama", "id_ed25519.pub")

	_, err = os.Stat(privKeyPath)
	if os.IsNotExist(err) {
		fmt.Printf("Couldn't find '%s'. Generating new private key.\n", privKeyPath)
Michael Yang's avatar
Michael Yang committed
1304
		cryptoPublicKey, cryptoPrivateKey, err := ed25519.GenerateKey(rand.Reader)
1305
1306
1307
1308
		if err != nil {
			return err
		}

Michael Yang's avatar
Michael Yang committed
1309
		privateKeyBytes, err := ssh.MarshalPrivateKey(cryptoPrivateKey, "")
1310
1311
1312
1313
		if err != nil {
			return err
		}

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

Michael Yang's avatar
Michael Yang committed
1318
		if err := os.WriteFile(privKeyPath, pem.EncodeToMemory(privateKeyBytes), 0o600); err != nil {
1319
1320
1321
			return err
		}

Michael Yang's avatar
Michael Yang committed
1322
		sshPublicKey, err := ssh.NewPublicKey(cryptoPublicKey)
1323
1324
1325
1326
		if err != nil {
			return err
		}

Michael Yang's avatar
Michael Yang committed
1327
		publicKeyBytes := ssh.MarshalAuthorizedKey(sshPublicKey)
1328

Michael Yang's avatar
Michael Yang committed
1329
		if err := os.WriteFile(pubKeyPath, publicKeyBytes, 0o644); err != nil {
1330
1331
1332
			return err
		}

Michael Yang's avatar
Michael Yang committed
1333
		fmt.Printf("Your new public key is: \n\n%s\n", publicKeyBytes)
1334
1335
1336
1337
	}
	return nil
}

Michael Yang's avatar
Michael Yang committed
1338
func checkServerHeartbeat(cmd *cobra.Command, _ []string) error {
Michael Yang's avatar
Michael Yang committed
1339
	client, err := api.ClientFromEnvironment()
1340
1341
1342
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
1343
	if err := client.Heartbeat(cmd.Context()); err != nil {
1344
		if !(strings.Contains(err.Error(), " refused") || strings.Contains(err.Error(), "could not connect")) {
Bruce MacDonald's avatar
Bruce MacDonald committed
1345
1346
			return err
		}
1347
		if err := startApp(cmd.Context(), client); err != nil {
1348
			return fmt.Errorf("ollama server not responding - %w", err)
1349
1350
1351
1352
1353
		}
	}
	return nil
}

Michael Yang's avatar
Michael Yang committed
1354
1355
1356
1357
1358
1359
1360
1361
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
1362
1363
1364
1365
1366
		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
1367
1368
	}

1369
	if serverVersion != version.Version {
Michael Yang's avatar
Michael Yang committed
1370
		fmt.Printf("Warning: client version is %s\n", version.Version)
1371
	}
Michael Yang's avatar
Michael Yang committed
1372
1373
}

1374
func appendEnvDocs(cmd *cobra.Command, envs []envconfig.EnvVar) {
1375
1376
1377
1378
1379
	if len(envs) == 0 {
		return
	}

	envUsage := `
1380
1381
Environment Variables:
`
1382
	for _, e := range envs {
1383
		envUsage += fmt.Sprintf("      %-24s   %s\n", e.Name, e.Description)
1384
1385
1386
	}

	cmd.SetUsageTemplate(cmd.UsageTemplate() + envUsage)
1387
1388
}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1389
1390
func NewCLI() *cobra.Command {
	log.SetFlags(log.LstdFlags | log.Lshortfile)
Michael Yang's avatar
Michael Yang committed
1391
	cobra.EnableCommandSorting = false
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1392

1393
	if runtime.GOOS == "windows" && term.IsTerminal(int(os.Stdout.Fd())) {
1394
		console.ConsoleFromFile(os.Stdin) //nolint:errcheck
1395
1396
	}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1397
	rootCmd := &cobra.Command{
1398
1399
1400
1401
		Use:           "ollama",
		Short:         "Large language model runner",
		SilenceUsage:  true,
		SilenceErrors: true,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1402
1403
1404
		CompletionOptions: cobra.CompletionOptions{
			DisableDefaultCmd: true,
		},
Michael Yang's avatar
Michael Yang committed
1405
1406
1407
1408
1409
1410
1411
1412
		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
1413
1414
	}

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

1417
	createCmd := &cobra.Command{
1418
1419
		Use:     "create MODEL",
		Short:   "Create a model from a Modelfile",
Michael Yang's avatar
Michael Yang committed
1420
		Args:    cobra.ExactArgs(1),
1421
1422
		PreRunE: checkServerHeartbeat,
		RunE:    CreateHandler,
1423
1424
	}

1425
	createCmd.Flags().StringP("file", "f", "", "Name of the Modelfile (default \"Modelfile\"")
1426
	createCmd.Flags().StringP("quantize", "q", "", "Quantize model to this level (e.g. q4_K_M)")
1427

Patrick Devine's avatar
Patrick Devine committed
1428
1429
1430
	showCmd := &cobra.Command{
		Use:     "show MODEL",
		Short:   "Show information for a model",
Michael Yang's avatar
Michael Yang committed
1431
		Args:    cobra.ExactArgs(1),
Patrick Devine's avatar
Patrick Devine committed
1432
1433
1434
1435
1436
1437
1438
1439
		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")
1440
	showCmd.Flags().Bool("system", false, "Show system message of a model")
1441
	showCmd.Flags().BoolP("verbose", "v", false, "Show detailed model information")
Patrick Devine's avatar
Patrick Devine committed
1442

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1443
	runCmd := &cobra.Command{
1444
1445
1446
1447
1448
		Use:     "run MODEL [PROMPT]",
		Short:   "Run a model",
		Args:    cobra.MinimumNArgs(1),
		PreRunE: checkServerHeartbeat,
		RunE:    RunHandler,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1449
1450
	}

1451
	runCmd.Flags().String("keepalive", "", "Duration to keep a model loaded (e.g. 5m)")
1452
	runCmd.Flags().Bool("verbose", false, "Show timings for response")
1453
	runCmd.Flags().Bool("insecure", false, "Use an insecure registry")
1454
	runCmd.Flags().Bool("nowordwrap", false, "Don't wrap words to the next line automatically")
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1455
	runCmd.Flags().String("format", "", "Response format (e.g. json)")
1456
1457
	runCmd.Flags().Bool("think", false, "Whether to use thinking mode for supported models")
	runCmd.Flags().Bool("hidethinking", false, "Hide thinking output (if provided)")
Patrick Devine's avatar
Patrick Devine committed
1458
1459
1460
1461
1462
1463
1464
1465
1466

	stopCmd := &cobra.Command{
		Use:     "stop MODEL",
		Short:   "Stop a running model",
		Args:    cobra.ExactArgs(1),
		PreRunE: checkServerHeartbeat,
		RunE:    StopHandler,
	}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1467
1468
1469
1470
	serveCmd := &cobra.Command{
		Use:     "serve",
		Aliases: []string{"start"},
		Short:   "Start ollama",
Michael Yang's avatar
Michael Yang committed
1471
		Args:    cobra.ExactArgs(0),
Michael Yang's avatar
Michael Yang committed
1472
		RunE:    RunServer,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1473
1474
	}

1475
	pullCmd := &cobra.Command{
1476
1477
		Use:     "pull MODEL",
		Short:   "Pull a model from a registry",
Michael Yang's avatar
Michael Yang committed
1478
		Args:    cobra.ExactArgs(1),
1479
1480
		PreRunE: checkServerHeartbeat,
		RunE:    PullHandler,
1481
1482
	}

1483
1484
	pullCmd.Flags().Bool("insecure", false, "Use an insecure registry")

1485
	pushCmd := &cobra.Command{
1486
1487
		Use:     "push MODEL",
		Short:   "Push a model to a registry",
Michael Yang's avatar
Michael Yang committed
1488
		Args:    cobra.ExactArgs(1),
1489
1490
		PreRunE: checkServerHeartbeat,
		RunE:    PushHandler,
1491
1492
	}

1493
1494
	pushCmd.Flags().Bool("insecure", false, "Use an insecure registry")

Patrick Devine's avatar
Patrick Devine committed
1495
	listCmd := &cobra.Command{
1496
		Use:     "list",
Patrick Devine's avatar
Patrick Devine committed
1497
		Aliases: []string{"ls"},
1498
		Short:   "List models",
1499
		PreRunE: checkServerHeartbeat,
1500
		RunE:    ListHandler,
1501
	}
1502
1503
1504
1505
1506
1507
1508

	psCmd := &cobra.Command{
		Use:     "ps",
		Short:   "List running models",
		PreRunE: checkServerHeartbeat,
		RunE:    ListRunningHandler,
	}
Patrick Devine's avatar
Patrick Devine committed
1509
	copyCmd := &cobra.Command{
Michael Yang's avatar
Michael Yang committed
1510
		Use:     "cp SOURCE DESTINATION",
1511
		Short:   "Copy a model",
Michael Yang's avatar
Michael Yang committed
1512
		Args:    cobra.ExactArgs(2),
1513
1514
		PreRunE: checkServerHeartbeat,
		RunE:    CopyHandler,
Patrick Devine's avatar
Patrick Devine committed
1515
1516
	}

1517
	deleteCmd := &cobra.Command{
Michael Yang's avatar
Michael Yang committed
1518
		Use:     "rm MODEL [MODEL...]",
1519
1520
1521
1522
		Short:   "Remove a model",
		Args:    cobra.MinimumNArgs(1),
		PreRunE: checkServerHeartbeat,
		RunE:    DeleteHandler,
Patrick Devine's avatar
Patrick Devine committed
1523
1524
	}

1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
	runnerCmd := &cobra.Command{
		Use:    "runner",
		Hidden: true,
		RunE: func(cmd *cobra.Command, args []string) error {
			return runner.Execute(os.Args[1:])
		},
		FParseErrWhitelist: cobra.FParseErrWhitelist{UnknownFlags: true},
	}
	runnerCmd.SetHelpFunc(func(cmd *cobra.Command, args []string) {
		_ = runner.Execute(args[1:])
	})

1537
1538
1539
	envVars := envconfig.AsMap()

	envs := []envconfig.EnvVar{envVars["OLLAMA_HOST"]}
1540

1541
1542
1543
1544
	for _, cmd := range []*cobra.Command{
		createCmd,
		showCmd,
		runCmd,
Patrick Devine's avatar
Patrick Devine committed
1545
		stopCmd,
1546
1547
1548
		pullCmd,
		pushCmd,
		listCmd,
1549
		psCmd,
1550
1551
		copyCmd,
		deleteCmd,
1552
		serveCmd,
1553
	} {
1554
1555
		switch cmd {
		case runCmd:
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
			appendEnvDocs(cmd, []envconfig.EnvVar{envVars["OLLAMA_HOST"], envVars["OLLAMA_NOHISTORY"]})
		case serveCmd:
			appendEnvDocs(cmd, []envconfig.EnvVar{
				envVars["OLLAMA_DEBUG"],
				envVars["OLLAMA_HOST"],
				envVars["OLLAMA_KEEP_ALIVE"],
				envVars["OLLAMA_MAX_LOADED_MODELS"],
				envVars["OLLAMA_MAX_QUEUE"],
				envVars["OLLAMA_MODELS"],
				envVars["OLLAMA_NUM_PARALLEL"],
				envVars["OLLAMA_NOPRUNE"],
				envVars["OLLAMA_ORIGINS"],
1568
				envVars["OLLAMA_SCHED_SPREAD"],
1569
				envVars["OLLAMA_FLASH_ATTENTION"],
1570
				envVars["OLLAMA_KV_CACHE_TYPE"],
1571
				envVars["OLLAMA_LLM_LIBRARY"],
1572
				envVars["OLLAMA_GPU_OVERHEAD"],
1573
				envVars["OLLAMA_LOAD_TIMEOUT"],
1574
			})
1575
1576
1577
		default:
			appendEnvDocs(cmd, envs)
		}
1578
1579
	}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1580
1581
	rootCmd.AddCommand(
		serveCmd,
1582
		createCmd,
Patrick Devine's avatar
Patrick Devine committed
1583
		showCmd,
1584
		runCmd,
Patrick Devine's avatar
Patrick Devine committed
1585
		stopCmd,
1586
1587
		pullCmd,
		pushCmd,
Patrick Devine's avatar
Patrick Devine committed
1588
		listCmd,
1589
		psCmd,
Patrick Devine's avatar
Patrick Devine committed
1590
		copyCmd,
1591
		deleteCmd,
1592
		runnerCmd,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1593
1594
1595
1596
	)

	return rootCmd
}
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638

// If the user has explicitly set thinking options, either through the CLI or
// through the `/set think` or `set nothink` interactive options, then we
// respect them. Otherwise, we check model capabilities to see if the model
// supports thinking. If the model does support thinking, we enable it.
// Otherwise, we unset the thinking option (which is different than setting it
// to false).
//
// If capabilities are not provided, we fetch them from the server.
func inferThinkingOption(caps *[]model.Capability, runOpts *runOptions, explicitlySetByUser bool) (*bool, error) {
	if explicitlySetByUser {
		return runOpts.Think, nil
	}

	if caps == nil {
		client, err := api.ClientFromEnvironment()
		if err != nil {
			return nil, err
		}
		ret, err := client.Show(context.Background(), &api.ShowRequest{
			Model: runOpts.Model,
		})
		if err != nil {
			return nil, err
		}
		caps = &ret.Capabilities
	}

	thinkingSupported := false
	for _, cap := range *caps {
		if cap == model.CapabilityThinking {
			thinkingSupported = true
		}
	}

	if thinkingSupported {
		thinking := true
		return &thinking, nil
	}

	return nil, nil
}