"tests/vscode:/vscode.git/clone" did not exist on "1f88baa5b7a9dde22b11200fd530fe1059e1facb"
cmd.go 41.2 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
// 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
	}
59
60
	if slices.Contains(resp.Capabilities, model.CapabilityThinking) {
		return
61
62
63
64
	}
	fmt.Fprintf(os.Stderr, "warning: model %q does not support thinking output\n", name)
}

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

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

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

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

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

84
85
86
87
	return absName, nil
}

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

91
92
93
94
95
96
97
98
99
100
	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
101
		return err
102
103
104
105
106
107
108
109
	} else {
		f, err := os.Open(filename)
		if err != nil {
			return err
		}

		reader = f
		defer f.Close()
Michael Yang's avatar
Michael Yang committed
110
111
	}

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

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

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

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

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

138
139
140
141
142
143
	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 {
144
			if _, err := createBlob(cmd, client, f, digest, p); err != nil {
Michael Yang's avatar
Michael Yang committed
145
146
				return err
			}
147
148
149
150
151
152
153

			// 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
		})
154
	}
Michael Yang's avatar
Michael Yang committed
155

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

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

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

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

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

199
200
201
		return nil
	}

202
	if err := client.Create(cmd.Context(), req, fn); err != nil {
203
204
205
		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")
		}
206
207
208
209
210
211
		return err
	}

	return nil
}

212
213
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
214
215
216
217
	if err != nil {
		return "", err
	}

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

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

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

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

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

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

260
261
262
263
264
265
266
267
268
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
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
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,
284
285
286

		// 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
287
288
289
290
291
292
293
294
295
296
297
298
299
300
	}

	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])
		}
301
		return err
Patrick Devine's avatar
Patrick Devine committed
302
303
304
305
	}
	return nil
}

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

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

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

321
322
	thinkFlag := cmd.Flags().Lookup("think")
	if thinkFlag.Changed {
Michael Yang's avatar
Michael Yang committed
323
		thinkStr, err := cmd.Flags().GetString("think")
324
325
326
		if err != nil {
			return err
		}
Michael Yang's avatar
Michael Yang committed
327
328
329
330
331
332
333
334
335
336
337
338
339

		// Handle different values for --think
		switch thinkStr {
		case "", "true":
			// --think or --think=true
			opts.Think = &api.ThinkValue{Value: true}
		case "false":
			opts.Think = &api.ThinkValue{Value: false}
		case "high", "medium", "low":
			opts.Think = &api.ThinkValue{Value: thinkStr}
		default:
			return fmt.Errorf("invalid value for --think: %q (must be true, false, high, medium, or low)", thinkStr)
		}
340
341
342
343
344
345
346
347
348
	} else {
		opts.Think = nil
	}
	hidethinking, err := cmd.Flags().GetBool("hidethinking")
	if err != nil {
		return err
	}
	opts.HideThinking = hidethinking

349
350
351
352
353
354
355
356
357
358
359
360
	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}
	}

361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
	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
	}
377
378
379
380
	// Be quiet if we're redirecting to a pipe or file
	if !term.IsTerminal(int(os.Stdout.Fd())) {
		interactive = false
	}
381
382
383
384
385
386
387

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

388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
	// 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
410
411
	}

412
413
414
415
416
	opts.Think, err = inferThinkingOption(&info.Capabilities, &opts, thinkFlag.Changed)
	if err != nil {
		return err
	}

417
418
419
420
421
	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
422
423
424
425
426
427
428
429
430
431
	if len(info.ProjectorInfo) != 0 {
		opts.MultiModal = true
	}
	for k := range info.ModelInfo {
		if strings.Contains(k, ".vision.") {
			opts.MultiModal = true
			break
		}
	}

432
433
434
	opts.ParentModel = info.Details.ParentModel

	if interactive {
Patrick Devine's avatar
Patrick Devine committed
435
		if err := loadOrUnloadModel(cmd, &opts); err != nil {
Michael Yang's avatar
Michael Yang committed
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
			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()
			}
		}

451
452
453
		return generateInteractive(cmd, opts)
	}
	return generate(cmd, opts)
Bruce MacDonald's avatar
Bruce MacDonald committed
454
455
}

456
func PushHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
457
	client, err := api.ClientFromEnvironment()
458
459
460
	if err != nil {
		return err
	}
461

462
463
464
465
466
	insecure, err := cmd.Flags().GetBool("insecure")
	if err != nil {
		return err
	}

Michael Yang's avatar
Michael Yang committed
467
468
469
470
	p := progress.NewProgress(os.Stderr)
	defer p.Stop()

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

474
	fn := func(resp api.ProgressResponse) error {
Michael Yang's avatar
Michael Yang committed
475
		if resp.Digest != "" {
476
477
478
			if spinner != nil {
				spinner.Stop()
			}
Michael Yang's avatar
Michael Yang committed
479
480
481

			bar, ok := bars[resp.Digest]
			if !ok {
482
				bar = progress.NewBar(fmt.Sprintf("pushing %s...", resp.Digest[7:19]), resp.Total, resp.Completed)
Michael Yang's avatar
Michael Yang committed
483
484
485
486
487
488
				bars[resp.Digest] = bar
				p.Add(resp.Digest, bar)
			}

			bar.Set(resp.Completed)
		} else if status != resp.Status {
489
490
491
			if spinner != nil {
				spinner.Stop()
			}
Michael Yang's avatar
Michael Yang committed
492
493
494
495
496
497

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

498
499
500
		return nil
	}

Michael Yang's avatar
Michael Yang committed
501
	request := api.PushRequest{Name: args[0], Insecure: insecure}
502
503

	n := model.ParseName(args[0])
Michael Yang's avatar
Michael Yang committed
504
	if err := client.Push(cmd.Context(), &request, fn); err != nil {
505
506
507
508
509
510
		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
511
512
513
		return err
	}

514
	p.Stop()
515
	spinner.Stop()
516
517
518
519
520
521
522
523

	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
524
	return nil
525
526
}

527
func ListHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
528
	client, err := api.ClientFromEnvironment()
529
530
531
	if err != nil {
		return err
	}
Patrick Devine's avatar
Patrick Devine committed
532

Michael Yang's avatar
Michael Yang committed
533
	models, err := client.List(cmd.Context())
Patrick Devine's avatar
Patrick Devine committed
534
535
536
537
538
539
540
	if err != nil {
		return err
	}

	var data [][]string

	for _, m := range models.Models {
541
		if len(args) == 0 || strings.HasPrefix(strings.ToLower(m.Name), strings.ToLower(args[0])) {
542
			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
543
		}
Patrick Devine's avatar
Patrick Devine committed
544
545
546
	}

	table := tablewriter.NewWriter(os.Stdout)
Patrick Devine's avatar
Patrick Devine committed
547
	table.SetHeader([]string{"NAME", "ID", "SIZE", "MODIFIED"})
Patrick Devine's avatar
Patrick Devine committed
548
549
550
551
552
	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
553
	table.SetTablePadding("    ")
Patrick Devine's avatar
Patrick Devine committed
554
555
556
557
558
559
	table.AppendBulk(data)
	table.Render()

	return nil
}

560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
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
588
589
590
591
592
593
594
595

			var until string
			delta := time.Since(m.ExpiresAt)
			if delta > 0 {
				until = "Stopping..."
			} else {
				until = format.HumanTime(m.ExpiresAt, "Never")
			}
596
597
			ctxStr := strconv.Itoa(m.ContextLength)
			data = append(data, []string{m.Name, m.Digest[:12], format.HumanBytes(m.Size), procStr, ctxStr, until})
598
599
600
601
		}
	}

	table := tablewriter.NewWriter(os.Stdout)
602
	table.SetHeader([]string{"NAME", "ID", "SIZE", "PROCESSOR", "CONTEXT", "UNTIL"})
603
604
605
606
607
	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
608
	table.SetTablePadding("    ")
609
610
611
612
613
614
	table.AppendBulk(data)
	table.Render()

	return nil
}

615
func DeleteHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
616
	client, err := api.ClientFromEnvironment()
617
618
619
	if err != nil {
		return err
	}
620

621
622
623
624
625
626
627
628
629
630
631
	// 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)
		}
	}

632
633
	for _, name := range args {
		req := api.DeleteRequest{Name: name}
Michael Yang's avatar
Michael Yang committed
634
		if err := client.Delete(cmd.Context(), &req); err != nil {
635
636
637
			return err
		}
		fmt.Printf("deleted '%s'\n", name)
638
639
640
641
	}
	return nil
}

Patrick Devine's avatar
Patrick Devine committed
642
func ShowHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
643
	client, err := api.ClientFromEnvironment()
Patrick Devine's avatar
Patrick Devine committed
644
645
646
647
648
649
650
651
652
	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")
653
	verbose, errVerbose := cmd.Flags().GetBool("verbose")
Patrick Devine's avatar
Patrick Devine committed
654

655
	for _, boolErr := range []error{errLicense, errModelfile, errParams, errSystem, errTemplate, errVerbose} {
Patrick Devine's avatar
Patrick Devine committed
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
		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 {
690
		return errors.New("only one of '--license', '--modelfile', '--parameters', '--system', or '--template' can be specified")
691
692
	}

693
	req := api.ShowRequest{Name: args[0], Verbose: verbose}
694
695
696
697
	resp, err := client.Show(cmd.Context(), &req)
	if err != nil {
		return err
	}
698

699
	if flagsSet == 1 {
700
701
702
703
704
705
706
707
		switch showType {
		case "license":
			fmt.Println(resp.License)
		case "modelfile":
			fmt.Println(resp.Modelfile)
		case "parameters":
			fmt.Println(resp.Parameters)
		case "system":
708
			fmt.Print(resp.System)
709
		case "template":
710
			fmt.Print(resp.Template)
711
712
713
		}

		return nil
Patrick Devine's avatar
Patrick Devine committed
714
715
	}

716
	return showInfo(resp, verbose, os.Stdout)
717
718
}

719
func showInfo(resp *api.ShowResponse, verbose bool, w io.Writer) error {
Michael Yang's avatar
Michael Yang committed
720
721
722
723
724
725
726
	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("    ")
727

Michael Yang's avatar
Michael Yang committed
728
729
730
		switch header {
		case "Template", "System", "License":
			table.SetColWidth(100)
731
732
		}

Michael Yang's avatar
Michael Yang committed
733
734
735
		table.AppendBulk(rows())
		table.Render()
		fmt.Fprintln(w)
Patrick Devine's avatar
Patrick Devine committed
736
737
	}

Michael Yang's avatar
Michael Yang committed
738
739
740
741
742
743
744
745
746
747
748
749
750
751
	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
	})
752

753
754
755
756
757
758
759
760
761
	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
762
763
764
765
766
767
768
769
770
	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
		})
771
772
	}

Michael Yang's avatar
Michael Yang committed
773
774
775
776
777
778
779
780
781
782
	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
		})
783
784
	}

785
786
787
788
789
790
791
792
793
794
795
	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) {
796
797
				case bool:
					v = fmt.Sprintf("%t", vData)
798
799
800
801
802
				case string:
					v = vData
				case float64:
					v = fmt.Sprintf("%g", vData)
				case []any:
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
					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)
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
					}
				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
853
854
	head := func(s string, n int) (rows [][]string) {
		scanner := bufio.NewScanner(strings.NewReader(s))
855
856
857
858
859
		count := 0
		for scanner.Scan() {
			text := strings.TrimSpace(scanner.Text())
			if text == "" {
				continue
860
			}
861
862
863
864
865
866
867
			count++
			if n < 0 || count <= n {
				rows = append(rows, []string{"", text})
			}
		}
		if n >= 0 && count > n {
			rows = append(rows, []string{"", "..."})
868
		}
Michael Yang's avatar
Michael Yang committed
869
		return
870
871
	}

Michael Yang's avatar
Michael Yang committed
872
873
874
875
876
	if resp.System != "" {
		tableRender("System", func() [][]string {
			return head(resp.System, 2)
		})
	}
877

Michael Yang's avatar
Michael Yang committed
878
879
880
881
	if resp.License != "" {
		tableRender("License", func() [][]string {
			return head(resp.License, 2)
		})
882
	}
Michael Yang's avatar
Michael Yang committed
883
884

	return nil
885
886
}

Patrick Devine's avatar
Patrick Devine committed
887
func CopyHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
888
	client, err := api.ClientFromEnvironment()
889
890
891
	if err != nil {
		return err
	}
Patrick Devine's avatar
Patrick Devine committed
892
893

	req := api.CopyRequest{Source: args[0], Destination: args[1]}
Michael Yang's avatar
Michael Yang committed
894
	if err := client.Copy(cmd.Context(), &req); err != nil {
Patrick Devine's avatar
Patrick Devine committed
895
896
897
898
899
900
		return err
	}
	fmt.Printf("copied '%s' to '%s'\n", args[0], args[1])
	return nil
}

901
func PullHandler(cmd *cobra.Command, args []string) error {
902
903
904
905
906
	insecure, err := cmd.Flags().GetBool("insecure")
	if err != nil {
		return err
	}

Michael Yang's avatar
Michael Yang committed
907
	client, err := api.ClientFromEnvironment()
908
909
910
	if err != nil {
		return err
	}
911

Michael Yang's avatar
Michael Yang committed
912
913
914
915
916
	p := progress.NewProgress(os.Stderr)
	defer p.Stop()

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

917
918
	var status string
	var spinner *progress.Spinner
Michael Yang's avatar
Michael Yang committed
919

920
	fn := func(resp api.ProgressResponse) error {
Michael Yang's avatar
Michael Yang committed
921
		if resp.Digest != "" {
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
			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
			}

942
943
944
			if spinner != nil {
				spinner.Stop()
			}
Michael Yang's avatar
Michael Yang committed
945
946
947

			bar, ok := bars[resp.Digest]
			if !ok {
948
949
950
951
952
953
				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
954
955
956
957
958
959
				bars[resp.Digest] = bar
				p.Add(resp.Digest, bar)
			}

			bar.Set(resp.Completed)
		} else if status != resp.Status {
960
961
962
			if spinner != nil {
				spinner.Stop()
			}
Michael Yang's avatar
Michael Yang committed
963
964
965
966
967
968

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

969
970
		return nil
	}
971

Michael Yang's avatar
Michael Yang committed
972
	request := api.PullRequest{Name: args[0], Insecure: insecure}
973
	return client.Pull(cmd.Context(), &request, fn)
Michael Yang's avatar
Michael Yang committed
974
975
}

976
977
type generateContextKey string

978
type runOptions struct {
979
980
981
982
983
984
985
986
987
988
989
	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
Michael Yang's avatar
Michael Yang committed
990
	Think        *api.ThinkValue
991
	HideThinking bool
992
993
}

994
995
996
997
998
999
1000
1001
1002
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
1003
1004
			if state.lineLength+1 > termWidth-5 {
				if runewidth.StringWidth(state.wordBuffer) > termWidth-10 {
1005
1006
1007
1008
1009
1010
1011
					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
1012
1013
				a := runewidth.StringWidth(state.wordBuffer)
				if a > 0 {
1014
					fmt.Printf("\x1b[%dD", a)
1015
1016
				}
				fmt.Printf("\x1b[K\n")
1017
				fmt.Printf("%s%c", state.wordBuffer, ch)
1018
1019
1020
				chWidth := runewidth.RuneWidth(ch)

				state.lineLength = runewidth.StringWidth(state.wordBuffer) + chWidth
1021
1022
			} else {
				fmt.Print(string(ch))
1023
1024
1025
1026
				state.lineLength += runewidth.RuneWidth(ch)
				if runewidth.RuneWidth(ch) >= 2 {
					state.wordBuffer = ""
					continue
Josh Yan's avatar
Josh Yan committed
1027
				}
1028
1029

				switch ch {
Michael Yang's avatar
Michael Yang committed
1030
				case ' ', '\t':
1031
					state.wordBuffer = ""
Michael Yang's avatar
Michael Yang committed
1032
				case '\n', '\r':
1033
					state.lineLength = 0
Michael Yang's avatar
Michael Yang committed
1034
					state.wordBuffer = ""
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
				default:
					state.wordBuffer += string(ch)
				}
			}
		}
	} else {
		fmt.Printf("%s%s", state.wordBuffer, content)
		if len(state.wordBuffer) > 0 {
			state.wordBuffer = ""
		}
	}
}

1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
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
}

1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
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{}
Michael Yang's avatar
Michael Yang committed
1092
	var thinkingContent strings.Builder
1093
1094
	var latest api.ChatResponse
	var fullResponse strings.Builder
1095
1096
	var thinkTagOpened bool = false
	var thinkTagClosed bool = false
1097

1098
1099
	role := "assistant"

1100
	fn := func(response api.ChatResponse) error {
1101
1102
1103
		if response.Message.Content != "" || !opts.HideThinking {
			p.StopAndClear()
		}
1104
1105
1106
1107

		latest = response

		role = response.Message.Role
1108
1109
1110
1111
		if response.Message.Thinking != "" && !opts.HideThinking {
			if !thinkTagOpened {
				fmt.Print(thinkingOutputOpeningText(false))
				thinkTagOpened = true
Michael Yang's avatar
Michael Yang committed
1112
				thinkTagClosed = false
1113
			}
Michael Yang's avatar
Michael Yang committed
1114
			thinkingContent.WriteString(response.Message.Thinking)
1115
1116
1117
			displayResponse(response.Message.Thinking, opts.WordWrap, state)
		}

1118
		content := response.Message.Content
Michael Yang's avatar
Michael Yang committed
1119
1120
1121
1122
		if thinkTagOpened && !thinkTagClosed && (content != "" || len(response.Message.ToolCalls) > 0) {
			if !strings.HasSuffix(thinkingContent.String(), "\n") {
				fmt.Println()
			}
1123
			fmt.Print(thinkingOutputClosingText(false))
Michael Yang's avatar
Michael Yang committed
1124
			thinkTagOpened = false
1125
			thinkTagClosed = true
Michael Yang's avatar
Michael Yang committed
1126
			state = &displayResponseState{}
1127
1128
1129
1130
1131
		}
		// 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)
1132
1133
		fullResponse.WriteString(content)

Michael Yang's avatar
Michael Yang committed
1134
1135
1136
1137
1138
1139
1140
		if response.Message.ToolCalls != nil {
			toolCalls := response.Message.ToolCalls
			if len(toolCalls) > 0 {
				fmt.Print(renderToolCalls(toolCalls, false))
			}
		}

1141
1142
1143
1144
1145
		displayResponse(content, opts.WordWrap, state)

		return nil
	}

1146
1147
1148
1149
	if opts.Format == "json" {
		opts.Format = `"` + opts.Format + `"`
	}

1150
1151
1152
	req := &api.ChatRequest{
		Model:    opts.Model,
		Messages: opts.Messages,
1153
		Format:   json.RawMessage(opts.Format),
1154
		Options:  opts.Options,
1155
		Think:    opts.Think,
1156
1157
	}

1158
1159
1160
1161
	if opts.KeepAlive != nil {
		req.KeepAlive = opts.KeepAlive
	}

1162
1163
1164
1165
	if err := client.Chat(cancelCtx, req, fn); err != nil {
		if errors.Is(err, context.Canceled) {
			return nil, nil
		}
1166
1167
1168
1169
1170
1171
1172
1173

		// this error should ideally be wrapped properly by the client
		if strings.Contains(err.Error(), "upstream error") {
			p.StopAndClear()
			fmt.Println("An error occurred while processing your message. Please try again.")
			fmt.Println()
			return nil, nil
		}
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
		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
1195
	client, err := api.ClientFromEnvironment()
Patrick Devine's avatar
Patrick Devine committed
1196
	if err != nil {
1197
		return err
Patrick Devine's avatar
Patrick Devine committed
1198
	}
Michael Yang's avatar
Michael Yang committed
1199

Michael Yang's avatar
Michael Yang committed
1200
	p := progress.NewProgress(os.Stderr)
1201
	defer p.StopAndClear()
1202

Michael Yang's avatar
Michael Yang committed
1203
1204
1205
	spinner := progress.NewSpinner("")
	p.Add("", spinner)

1206
1207
1208
1209
1210
1211
1212
	var latest api.GenerateResponse

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

Michael Yang's avatar
Michael Yang committed
1213
	ctx, cancel := context.WithCancel(cmd.Context())
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
	defer cancel()

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

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

1224
	var state *displayResponseState = &displayResponseState{}
Michael Yang's avatar
Michael Yang committed
1225
	var thinkingContent strings.Builder
1226
1227
	var thinkTagOpened bool = false
	var thinkTagClosed bool = false
1228

1229
	plainText := !term.IsTerminal(int(os.Stdout.Fd()))
1230

1231
	fn := func(response api.GenerateResponse) error {
Patrick Devine's avatar
Patrick Devine committed
1232
		latest = response
1233
		content := response.Response
1234

1235
1236
1237
1238
1239
1240
1241
1242
		if response.Response != "" || !opts.HideThinking {
			p.StopAndClear()
		}

		if response.Thinking != "" && !opts.HideThinking {
			if !thinkTagOpened {
				fmt.Print(thinkingOutputOpeningText(plainText))
				thinkTagOpened = true
Michael Yang's avatar
Michael Yang committed
1243
				thinkTagClosed = false
1244
			}
Michael Yang's avatar
Michael Yang committed
1245
			thinkingContent.WriteString(response.Thinking)
1246
1247
1248
			displayResponse(response.Thinking, opts.WordWrap, state)
		}

Michael Yang's avatar
Michael Yang committed
1249
1250
1251
1252
		if thinkTagOpened && !thinkTagClosed && (content != "" || len(response.ToolCalls) > 0) {
			if !strings.HasSuffix(thinkingContent.String(), "\n") {
				fmt.Println()
			}
1253
			fmt.Print(thinkingOutputClosingText(plainText))
Michael Yang's avatar
Michael Yang committed
1254
			thinkTagOpened = false
1255
			thinkTagClosed = true
Michael Yang's avatar
Michael Yang committed
1256
			state = &displayResponseState{}
1257
1258
		}

1259
		displayResponse(content, opts.WordWrap, state)
1260

Michael Yang's avatar
Michael Yang committed
1261
1262
1263
1264
1265
1266
1267
		if response.ToolCalls != nil {
			toolCalls := response.ToolCalls
			if len(toolCalls) > 0 {
				fmt.Print(renderToolCalls(toolCalls, plainText))
			}
		}

Patrick Devine's avatar
Patrick Devine committed
1268
1269
		return nil
	}
1270

1271
1272
1273
1274
1275
1276
1277
	if opts.MultiModal {
		opts.Prompt, opts.Images, err = extractFileData(opts.Prompt)
		if err != nil {
			return err
		}
	}

1278
1279
1280
1281
	if opts.Format == "json" {
		opts.Format = `"` + opts.Format + `"`
	}

Michael Yang's avatar
Michael Yang committed
1282
	request := api.GenerateRequest{
1283
1284
1285
1286
		Model:     opts.Model,
		Prompt:    opts.Prompt,
		Context:   generateContext,
		Images:    opts.Images,
1287
		Format:    json.RawMessage(opts.Format),
1288
1289
1290
		System:    opts.System,
		Options:   opts.Options,
		KeepAlive: opts.KeepAlive,
1291
		Think:     opts.Think,
Michael Yang's avatar
Michael Yang committed
1292
1293
1294
	}

	if err := client.Generate(ctx, &request, fn); err != nil {
1295
		if errors.Is(err, context.Canceled) {
1296
			return nil
1297
		}
1298
		return err
Patrick Devine's avatar
Patrick Devine committed
1299
	}
1300

1301
	if opts.Prompt != "" {
Michael Yang's avatar
Michael Yang committed
1302
1303
		fmt.Println()
		fmt.Println()
Patrick Devine's avatar
Patrick Devine committed
1304
	}
1305

1306
1307
1308
1309
	if !latest.Done {
		return nil
	}

Patrick Devine's avatar
Patrick Devine committed
1310
1311
	verbose, err := cmd.Flags().GetBool("verbose")
	if err != nil {
1312
		return err
Patrick Devine's avatar
Patrick Devine committed
1313
	}
Michael Yang's avatar
Michael Yang committed
1314

Patrick Devine's avatar
Patrick Devine committed
1315
1316
	if verbose {
		latest.Summary()
Michael Yang's avatar
Michael Yang committed
1317
	}
Michael Yang's avatar
Michael Yang committed
1318

Patrick Devine's avatar
Patrick Devine committed
1319
1320
1321
	ctx = context.WithValue(cmd.Context(), generateContextKey("context"), latest.Context)
	cmd.SetContext(ctx)

1322
	return nil
Michael Yang's avatar
Michael Yang committed
1323
1324
}

1325
func RunServer(_ *cobra.Command, _ []string) error {
Michael Yang's avatar
Michael Yang committed
1326
	if err := initializeKeypair(); err != nil {
1327
1328
1329
		return err
	}

Michael Yang's avatar
host  
Michael Yang committed
1330
	ln, err := net.Listen("tcp", envconfig.Host().Host)
1331
1332
1333
	if err != nil {
		return err
	}
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1334

1335
1336
1337
1338
1339
1340
	err = server.Serve(ln)
	if errors.Is(err, http.ErrServerClosed) {
		return nil
	}

	return err
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1341
1342
}

1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
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
1355
		cryptoPublicKey, cryptoPrivateKey, err := ed25519.GenerateKey(rand.Reader)
1356
1357
1358
1359
		if err != nil {
			return err
		}

Michael Yang's avatar
Michael Yang committed
1360
		privateKeyBytes, err := ssh.MarshalPrivateKey(cryptoPrivateKey, "")
1361
1362
1363
1364
		if err != nil {
			return err
		}

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

Michael Yang's avatar
Michael Yang committed
1369
		if err := os.WriteFile(privKeyPath, pem.EncodeToMemory(privateKeyBytes), 0o600); err != nil {
1370
1371
1372
			return err
		}

Michael Yang's avatar
Michael Yang committed
1373
		sshPublicKey, err := ssh.NewPublicKey(cryptoPublicKey)
1374
1375
1376
1377
		if err != nil {
			return err
		}

Michael Yang's avatar
Michael Yang committed
1378
		publicKeyBytes := ssh.MarshalAuthorizedKey(sshPublicKey)
1379

Michael Yang's avatar
Michael Yang committed
1380
		if err := os.WriteFile(pubKeyPath, publicKeyBytes, 0o644); err != nil {
1381
1382
1383
			return err
		}

Michael Yang's avatar
Michael Yang committed
1384
		fmt.Printf("Your new public key is: \n\n%s\n", publicKeyBytes)
1385
1386
1387
1388
	}
	return nil
}

Michael Yang's avatar
Michael Yang committed
1389
func checkServerHeartbeat(cmd *cobra.Command, _ []string) error {
Michael Yang's avatar
Michael Yang committed
1390
	client, err := api.ClientFromEnvironment()
1391
1392
1393
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
1394
	if err := client.Heartbeat(cmd.Context()); err != nil {
1395
		if !(strings.Contains(err.Error(), " refused") || strings.Contains(err.Error(), "could not connect")) {
Bruce MacDonald's avatar
Bruce MacDonald committed
1396
1397
			return err
		}
1398
		if err := startApp(cmd.Context(), client); err != nil {
1399
			return fmt.Errorf("ollama server not responding - %w", err)
1400
1401
1402
1403
1404
		}
	}
	return nil
}

Michael Yang's avatar
Michael Yang committed
1405
1406
1407
1408
1409
1410
1411
1412
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
1413
1414
1415
1416
1417
		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
1418
1419
	}

1420
	if serverVersion != version.Version {
Michael Yang's avatar
Michael Yang committed
1421
		fmt.Printf("Warning: client version is %s\n", version.Version)
1422
	}
Michael Yang's avatar
Michael Yang committed
1423
1424
}

1425
func appendEnvDocs(cmd *cobra.Command, envs []envconfig.EnvVar) {
1426
1427
1428
1429
1430
	if len(envs) == 0 {
		return
	}

	envUsage := `
1431
1432
Environment Variables:
`
1433
	for _, e := range envs {
1434
		envUsage += fmt.Sprintf("      %-24s   %s\n", e.Name, e.Description)
1435
1436
1437
	}

	cmd.SetUsageTemplate(cmd.UsageTemplate() + envUsage)
1438
1439
}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1440
1441
func NewCLI() *cobra.Command {
	log.SetFlags(log.LstdFlags | log.Lshortfile)
Michael Yang's avatar
Michael Yang committed
1442
	cobra.EnableCommandSorting = false
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1443

1444
	if runtime.GOOS == "windows" && term.IsTerminal(int(os.Stdout.Fd())) {
1445
		console.ConsoleFromFile(os.Stdin) //nolint:errcheck
1446
1447
	}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1448
	rootCmd := &cobra.Command{
1449
1450
1451
1452
		Use:           "ollama",
		Short:         "Large language model runner",
		SilenceUsage:  true,
		SilenceErrors: true,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1453
1454
1455
		CompletionOptions: cobra.CompletionOptions{
			DisableDefaultCmd: true,
		},
Michael Yang's avatar
Michael Yang committed
1456
1457
1458
1459
1460
1461
1462
1463
		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
1464
1465
	}

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

1468
	createCmd := &cobra.Command{
1469
		Use:     "create MODEL",
1470
		Short:   "Create a model",
Michael Yang's avatar
Michael Yang committed
1471
		Args:    cobra.ExactArgs(1),
1472
1473
		PreRunE: checkServerHeartbeat,
		RunE:    CreateHandler,
1474
1475
	}

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

Patrick Devine's avatar
Patrick Devine committed
1479
1480
1481
	showCmd := &cobra.Command{
		Use:     "show MODEL",
		Short:   "Show information for a model",
Michael Yang's avatar
Michael Yang committed
1482
		Args:    cobra.ExactArgs(1),
Patrick Devine's avatar
Patrick Devine committed
1483
1484
1485
1486
1487
1488
1489
1490
		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")
1491
	showCmd.Flags().Bool("system", false, "Show system message of a model")
1492
	showCmd.Flags().BoolP("verbose", "v", false, "Show detailed model information")
Patrick Devine's avatar
Patrick Devine committed
1493

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1494
	runCmd := &cobra.Command{
1495
1496
1497
1498
1499
		Use:     "run MODEL [PROMPT]",
		Short:   "Run a model",
		Args:    cobra.MinimumNArgs(1),
		PreRunE: checkServerHeartbeat,
		RunE:    RunHandler,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1500
1501
	}

1502
	runCmd.Flags().String("keepalive", "", "Duration to keep a model loaded (e.g. 5m)")
1503
	runCmd.Flags().Bool("verbose", false, "Show timings for response")
1504
	runCmd.Flags().Bool("insecure", false, "Use an insecure registry")
1505
	runCmd.Flags().Bool("nowordwrap", false, "Don't wrap words to the next line automatically")
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1506
	runCmd.Flags().String("format", "", "Response format (e.g. json)")
Michael Yang's avatar
Michael Yang committed
1507
1508
	runCmd.Flags().String("think", "", "Enable thinking mode: true/false or high/medium/low for supported models")
	runCmd.Flags().Lookup("think").NoOptDefVal = "true"
1509
	runCmd.Flags().Bool("hidethinking", false, "Hide thinking output (if provided)")
Patrick Devine's avatar
Patrick Devine committed
1510
1511
1512
1513
1514
1515
1516
1517
1518

	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
1519
1520
1521
1522
	serveCmd := &cobra.Command{
		Use:     "serve",
		Aliases: []string{"start"},
		Short:   "Start ollama",
Michael Yang's avatar
Michael Yang committed
1523
		Args:    cobra.ExactArgs(0),
Michael Yang's avatar
Michael Yang committed
1524
		RunE:    RunServer,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1525
1526
	}

1527
	pullCmd := &cobra.Command{
1528
1529
		Use:     "pull MODEL",
		Short:   "Pull a model from a registry",
Michael Yang's avatar
Michael Yang committed
1530
		Args:    cobra.ExactArgs(1),
1531
1532
		PreRunE: checkServerHeartbeat,
		RunE:    PullHandler,
1533
1534
	}

1535
1536
	pullCmd.Flags().Bool("insecure", false, "Use an insecure registry")

1537
	pushCmd := &cobra.Command{
1538
1539
		Use:     "push MODEL",
		Short:   "Push a model to a registry",
Michael Yang's avatar
Michael Yang committed
1540
		Args:    cobra.ExactArgs(1),
1541
1542
		PreRunE: checkServerHeartbeat,
		RunE:    PushHandler,
1543
1544
	}

1545
1546
	pushCmd.Flags().Bool("insecure", false, "Use an insecure registry")

Patrick Devine's avatar
Patrick Devine committed
1547
	listCmd := &cobra.Command{
1548
		Use:     "list",
Patrick Devine's avatar
Patrick Devine committed
1549
		Aliases: []string{"ls"},
1550
		Short:   "List models",
1551
		PreRunE: checkServerHeartbeat,
1552
		RunE:    ListHandler,
1553
	}
1554
1555
1556
1557
1558
1559
1560

	psCmd := &cobra.Command{
		Use:     "ps",
		Short:   "List running models",
		PreRunE: checkServerHeartbeat,
		RunE:    ListRunningHandler,
	}
Patrick Devine's avatar
Patrick Devine committed
1561
	copyCmd := &cobra.Command{
Michael Yang's avatar
Michael Yang committed
1562
		Use:     "cp SOURCE DESTINATION",
1563
		Short:   "Copy a model",
Michael Yang's avatar
Michael Yang committed
1564
		Args:    cobra.ExactArgs(2),
1565
1566
		PreRunE: checkServerHeartbeat,
		RunE:    CopyHandler,
Patrick Devine's avatar
Patrick Devine committed
1567
1568
	}

1569
	deleteCmd := &cobra.Command{
Michael Yang's avatar
Michael Yang committed
1570
		Use:     "rm MODEL [MODEL...]",
1571
1572
1573
1574
		Short:   "Remove a model",
		Args:    cobra.MinimumNArgs(1),
		PreRunE: checkServerHeartbeat,
		RunE:    DeleteHandler,
Patrick Devine's avatar
Patrick Devine committed
1575
1576
	}

1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
	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:])
	})

1589
1590
1591
	envVars := envconfig.AsMap()

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

1593
1594
1595
1596
	for _, cmd := range []*cobra.Command{
		createCmd,
		showCmd,
		runCmd,
Patrick Devine's avatar
Patrick Devine committed
1597
		stopCmd,
1598
1599
1600
		pullCmd,
		pushCmd,
		listCmd,
1601
		psCmd,
1602
1603
		copyCmd,
		deleteCmd,
1604
		serveCmd,
1605
	} {
1606
1607
		switch cmd {
		case runCmd:
1608
1609
1610
1611
1612
			appendEnvDocs(cmd, []envconfig.EnvVar{envVars["OLLAMA_HOST"], envVars["OLLAMA_NOHISTORY"]})
		case serveCmd:
			appendEnvDocs(cmd, []envconfig.EnvVar{
				envVars["OLLAMA_DEBUG"],
				envVars["OLLAMA_HOST"],
1613
				envVars["OLLAMA_CONTEXT_LENGTH"],
1614
1615
1616
1617
1618
1619
1620
				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"],
1621
				envVars["OLLAMA_SCHED_SPREAD"],
1622
				envVars["OLLAMA_FLASH_ATTENTION"],
1623
				envVars["OLLAMA_KV_CACHE_TYPE"],
1624
				envVars["OLLAMA_LLM_LIBRARY"],
1625
				envVars["OLLAMA_GPU_OVERHEAD"],
1626
				envVars["OLLAMA_LOAD_TIMEOUT"],
1627
			})
1628
1629
1630
		default:
			appendEnvDocs(cmd, envs)
		}
1631
1632
	}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1633
1634
	rootCmd.AddCommand(
		serveCmd,
1635
		createCmd,
Patrick Devine's avatar
Patrick Devine committed
1636
		showCmd,
1637
		runCmd,
Patrick Devine's avatar
Patrick Devine committed
1638
		stopCmd,
1639
1640
		pullCmd,
		pushCmd,
Patrick Devine's avatar
Patrick Devine committed
1641
		listCmd,
1642
		psCmd,
Patrick Devine's avatar
Patrick Devine committed
1643
		copyCmd,
1644
		deleteCmd,
1645
		runnerCmd,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1646
1647
1648
1649
	)

	return rootCmd
}
1650
1651
1652
1653
1654
1655
1656
1657
1658

// 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.
Michael Yang's avatar
Michael Yang committed
1659
func inferThinkingOption(caps *[]model.Capability, runOpts *runOptions, explicitlySetByUser bool) (*api.ThinkValue, error) {
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
	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 {
Michael Yang's avatar
Michael Yang committed
1686
		return &api.ThinkValue{Value: true}, nil
1687
1688
1689
1690
	}

	return nil, nil
}
Michael Yang's avatar
Michael Yang committed
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716

func renderToolCalls(toolCalls []api.ToolCall, plainText bool) string {
	out := ""
	formatExplanation := ""
	formatValues := ""
	if !plainText {
		formatExplanation = readline.ColorGrey + readline.ColorBold
		formatValues = readline.ColorDefault
		out += formatExplanation
	}
	for i, toolCall := range toolCalls {
		argsAsJSON, err := json.Marshal(toolCall.Function.Arguments)
		if err != nil {
			return ""
		}
		if i > 0 {
			out += "\n"
		}
		// all tool calls are unexpected since we don't currently support registering any in the CLI
		out += fmt.Sprintf("  Model called a non-existent function '%s()' with arguments: %s", formatValues+toolCall.Function.Name+formatExplanation, formatValues+string(argsAsJSON)+formatExplanation)
	}
	if !plainText {
		out += readline.ColorDefault
	}
	return out
}