cmd.go 30.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"
Michael Yang's avatar
Michael Yang committed
21
	"strconv"
Michael Yang's avatar
Michael Yang committed
22
	"strings"
23
	"sync/atomic"
24
	"syscall"
Michael Yang's avatar
Michael Yang committed
25
	"time"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
26

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

34
	"github.com/ollama/ollama/api"
35
	"github.com/ollama/ollama/envconfig"
36
	"github.com/ollama/ollama/format"
37
	"github.com/ollama/ollama/parser"
38
	"github.com/ollama/ollama/progress"
Jesse Gross's avatar
Jesse Gross committed
39
	"github.com/ollama/ollama/runner"
40
	"github.com/ollama/ollama/server"
41
	"github.com/ollama/ollama/types/model"
42
	"github.com/ollama/ollama/version"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
43
44
)

45
var errModelfileNotFound = errors.New("specified Modelfile wasn't found")
46
47

func getModelfileName(cmd *cobra.Command) (string, error) {
48
	filename, _ := cmd.Flags().GetString("file")
49
50
51
52
53
54

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

	absName, err := filepath.Abs(filename)
55
	if err != nil {
56
		return "", err
57
58
	}

59
	_, err = os.Stat(absName)
60
	if err != nil {
61
		return "", err
62
	}
63

64
65
66
67
	return absName, nil
}

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

71
72
73
74
75
76
77
78
79
80
	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
81
		return err
82
83
84
85
86
87
88
89
	} else {
		f, err := os.Open(filename)
		if err != nil {
			return err
		}

		reader = f
		defer f.Close()
Michael Yang's avatar
Michael Yang committed
90
91
	}

92
	modelfile, err := parser.ParseFile(reader)
Michael Yang's avatar
Michael Yang committed
93
94
95
96
	if err != nil {
		return err
	}

97
98
99
100
	status := "gathering model components"
	spinner := progress.NewSpinner(status)
	p.Add(status, spinner)

101
	req, err := modelfile.CreateRequest(filepath.Dir(filename))
Michael Yang's avatar
Michael Yang committed
102
103
104
	if err != nil {
		return err
	}
105
	spinner.Stop()
Michael Yang's avatar
Michael Yang committed
106

107
108
109
110
111
	req.Name = args[0]
	quantize, _ := cmd.Flags().GetString("quantize")
	if quantize != "" {
		req.Quantize = quantize
	}
112

113
114
115
116
117
	client, err := api.ClientFromEnvironment()
	if err != nil {
		return err
	}

118
119
120
121
	if len(req.Files) > 0 {
		fileMap := map[string]string{}
		for f, digest := range req.Files {
			if _, err := createBlob(cmd, client, f, digest, p); err != nil {
Michael Yang's avatar
Michael Yang committed
122
123
				return err
			}
124
125
126
127
			fileMap[filepath.Base(f)] = digest
		}
		req.Files = fileMap
	}
Michael Yang's avatar
Michael Yang committed
128

129
130
131
132
	if len(req.Adapters) > 0 {
		fileMap := map[string]string{}
		for f, digest := range req.Adapters {
			if _, err := createBlob(cmd, client, f, digest, p); err != nil {
Michael Yang's avatar
Michael Yang committed
133
134
				return err
			}
135
			fileMap[filepath.Base(f)] = digest
Michael Yang's avatar
Michael Yang committed
136
		}
137
		req.Adapters = fileMap
Michael Yang's avatar
Michael Yang committed
138
	}
Michael Yang's avatar
Michael Yang committed
139

Michael Yang's avatar
Michael Yang committed
140
	bars := make(map[string]*progress.Bar)
141
	fn := func(resp api.ProgressResponse) error {
Michael Yang's avatar
Michael Yang committed
142
143
144
		if resp.Digest != "" {
			bar, ok := bars[resp.Digest]
			if !ok {
145
				bar = progress.NewBar(fmt.Sprintf("pulling %s...", resp.Digest[7:19]), resp.Total, resp.Completed)
Michael Yang's avatar
Michael Yang committed
146
147
148
149
150
151
152
153
154
155
156
157
158
				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)
		}

159
160
161
		return nil
	}

162
	if err := client.Create(cmd.Context(), req, fn); err != nil {
163
164
165
		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")
		}
166
167
168
169
170
171
		return err
	}

	return nil
}

172
173
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
174
175
176
177
	if err != nil {
		return "", err
	}

178
	bin, err := os.Open(realPath)
179
180
181
182
183
	if err != nil {
		return "", err
	}
	defer bin.Close()

184
185
186
187
188
189
190
191
	// Get file info to retrieve the size
	fileInfo, err := bin.Stat()
	if err != nil {
		return "", err
	}
	fileSize := fileInfo.Size()

	var pw progressWriter
192
193
194
195
	status := fmt.Sprintf("copying file %s 0%%", digest)
	spinner := progress.NewSpinner(status)
	p.Add(status, spinner)
	defer spinner.Stop()
196
197
198
199
200
201
202
203
204
205

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

	go func() {
		ticker := time.NewTicker(60 * time.Millisecond)
		defer ticker.Stop()
		for {
			select {
			case <-ticker.C:
206
				spinner.SetMessage(fmt.Sprintf("copying file %s %d%%", digest, int(100*pw.n.Load()/fileSize)))
207
			case <-done:
208
				spinner.SetMessage(fmt.Sprintf("copying file %s 100%%", digest))
209
210
211
212
213
214
				return
			}
		}
	}()

	if err = client.CreateBlob(cmd.Context(), digest, io.TeeReader(bin, &pw)); err != nil {
215
216
217
218
219
		return "", err
	}
	return digest, nil
}

220
221
222
223
224
225
226
227
228
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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
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,
	}

	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])
		}
258
		return err
Patrick Devine's avatar
Patrick Devine committed
259
260
261
262
	}
	return nil
}

263
func RunHandler(cmd *cobra.Command, args []string) error {
264
265
266
	interactive := true

	opts := runOptions{
267
268
269
		Model:    args[0],
		WordWrap: os.Getenv("TERM") == "xterm-256color",
		Options:  map[string]interface{}{},
270
271
272
273
274
275
276
277
	}

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

278
279
280
281
282
283
284
285
286
287
288
289
	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}
	}

290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
	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
	}
306
307
308
309
	// Be quiet if we're redirecting to a pipe or file
	if !term.IsTerminal(int(os.Stdout.Fd())) {
		interactive = false
	}
310
311
312
313
314
315
316

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

317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
	// 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
339
340
	}

341
342
343
344
345
346
347
348
349
350
	if len(info.ProjectorInfo) != 0 {
		opts.MultiModal = true
	}
	for k := range info.ModelInfo {
		if strings.Contains(k, ".vision.") {
			opts.MultiModal = true
			break
		}
	}

351
352
353
	opts.ParentModel = info.Details.ParentModel

	if interactive {
Patrick Devine's avatar
Patrick Devine committed
354
		if err := loadOrUnloadModel(cmd, &opts); err != nil {
Michael Yang's avatar
Michael Yang committed
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
			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()
			}
		}

370
371
372
		return generateInteractive(cmd, opts)
	}
	return generate(cmd, opts)
Bruce MacDonald's avatar
Bruce MacDonald committed
373
374
}

375
func PushHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
376
	client, err := api.ClientFromEnvironment()
377
378
379
	if err != nil {
		return err
	}
380

381
382
383
384
385
	insecure, err := cmd.Flags().GetBool("insecure")
	if err != nil {
		return err
	}

Michael Yang's avatar
Michael Yang committed
386
387
388
389
	p := progress.NewProgress(os.Stderr)
	defer p.Stop()

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

393
	fn := func(resp api.ProgressResponse) error {
Michael Yang's avatar
Michael Yang committed
394
		if resp.Digest != "" {
395
396
397
			if spinner != nil {
				spinner.Stop()
			}
Michael Yang's avatar
Michael Yang committed
398
399
400

			bar, ok := bars[resp.Digest]
			if !ok {
401
				bar = progress.NewBar(fmt.Sprintf("pushing %s...", resp.Digest[7:19]), resp.Total, resp.Completed)
Michael Yang's avatar
Michael Yang committed
402
403
404
405
406
407
				bars[resp.Digest] = bar
				p.Add(resp.Digest, bar)
			}

			bar.Set(resp.Completed)
		} else if status != resp.Status {
408
409
410
			if spinner != nil {
				spinner.Stop()
			}
Michael Yang's avatar
Michael Yang committed
411
412
413
414
415
416

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

417
418
419
		return nil
	}

Michael Yang's avatar
Michael Yang committed
420
	request := api.PushRequest{Name: args[0], Insecure: insecure}
421
422

	n := model.ParseName(args[0])
Michael Yang's avatar
Michael Yang committed
423
	if err := client.Push(cmd.Context(), &request, fn); err != nil {
424
425
426
427
428
429
		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
430
431
432
		return err
	}

433
	p.Stop()
434
	spinner.Stop()
435
436
437
438
439
440
441
442

	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
443
	return nil
444
445
}

446
func ListHandler(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
	}
Patrick Devine's avatar
Patrick Devine committed
451

Michael Yang's avatar
Michael Yang committed
452
	models, err := client.List(cmd.Context())
Patrick Devine's avatar
Patrick Devine committed
453
454
455
456
457
458
459
	if err != nil {
		return err
	}

	var data [][]string

	for _, m := range models.Models {
460
		if len(args) == 0 || strings.HasPrefix(strings.ToLower(m.Name), strings.ToLower(args[0])) {
461
			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
462
		}
Patrick Devine's avatar
Patrick Devine committed
463
464
465
	}

	table := tablewriter.NewWriter(os.Stdout)
Patrick Devine's avatar
Patrick Devine committed
466
	table.SetHeader([]string{"NAME", "ID", "SIZE", "MODIFIED"})
Patrick Devine's avatar
Patrick Devine committed
467
468
469
470
471
	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
472
	table.SetTablePadding("    ")
Patrick Devine's avatar
Patrick Devine committed
473
474
475
476
477
478
	table.AppendBulk(data)
	table.Render()

	return nil
}

479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
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
507
508
509
510
511
512
513
514
515

			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})
516
517
518
519
520
521
522
523
524
525
		}
	}

	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
526
	table.SetTablePadding("    ")
527
528
529
530
531
532
	table.AppendBulk(data)
	table.Render()

	return nil
}

533
func DeleteHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
534
	client, err := api.ClientFromEnvironment()
535
536
537
	if err != nil {
		return err
	}
538

539
540
541
542
543
544
545
546
547
548
549
	// 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)
		}
	}

550
551
	for _, name := range args {
		req := api.DeleteRequest{Name: name}
Michael Yang's avatar
Michael Yang committed
552
		if err := client.Delete(cmd.Context(), &req); err != nil {
553
554
555
			return err
		}
		fmt.Printf("deleted '%s'\n", name)
556
557
558
559
	}
	return nil
}

Patrick Devine's avatar
Patrick Devine committed
560
func ShowHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
561
	client, err := api.ClientFromEnvironment()
Patrick Devine's avatar
Patrick Devine committed
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
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
	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")

	for _, boolErr := range []error{errLicense, errModelfile, errParams, errSystem, errTemplate} {
		if boolErr != nil {
			return errors.New("error retrieving flags")
		}
	}

	flagsSet := 0
	showType := ""

	if license {
		flagsSet++
		showType = "license"
	}

	if modelfile {
		flagsSet++
		showType = "modelfile"
	}

	if parameters {
		flagsSet++
		showType = "parameters"
	}

	if system {
		flagsSet++
		showType = "system"
	}

	if template {
		flagsSet++
		showType = "template"
	}

	if flagsSet > 1 {
607
		return errors.New("only one of '--license', '--modelfile', '--parameters', '--system', or '--template' can be specified")
608
609
	}

610
611
612
613
614
	req := api.ShowRequest{Name: args[0]}
	resp, err := client.Show(cmd.Context(), &req)
	if err != nil {
		return err
	}
615

616
	if flagsSet == 1 {
617
618
619
620
621
622
623
624
		switch showType {
		case "license":
			fmt.Println(resp.License)
		case "modelfile":
			fmt.Println(resp.Modelfile)
		case "parameters":
			fmt.Println(resp.Parameters)
		case "system":
625
			fmt.Print(resp.System)
626
		case "template":
627
			fmt.Print(resp.Template)
628
629
630
		}

		return nil
Patrick Devine's avatar
Patrick Devine committed
631
632
	}

Michael Yang's avatar
Michael Yang committed
633
	return showInfo(resp, os.Stdout)
634
635
}

Michael Yang's avatar
Michael Yang committed
636
637
638
639
640
641
642
643
func showInfo(resp *api.ShowResponse, w io.Writer) error {
	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("    ")
644

Michael Yang's avatar
Michael Yang committed
645
646
647
		switch header {
		case "Template", "System", "License":
			table.SetColWidth(100)
648
649
		}

Michael Yang's avatar
Michael Yang committed
650
651
652
		table.AppendBulk(rows())
		table.Render()
		fmt.Fprintln(w)
Patrick Devine's avatar
Patrick Devine committed
653
654
	}

Michael Yang's avatar
Michael Yang committed
655
656
657
658
659
660
661
662
663
664
665
666
667
668
	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
	})
669

Michael Yang's avatar
Michael Yang committed
670
671
672
673
674
675
676
677
678
	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
		})
679
680
	}

Michael Yang's avatar
Michael Yang committed
681
682
683
684
685
686
687
688
689
690
	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
		})
691
692
	}

Michael Yang's avatar
Michael Yang committed
693
694
695
696
697
	head := func(s string, n int) (rows [][]string) {
		scanner := bufio.NewScanner(strings.NewReader(s))
		for scanner.Scan() && (len(rows) < n || n < 0) {
			if text := scanner.Text(); text != "" {
				rows = append(rows, []string{"", strings.TrimSpace(text)})
698
699
			}
		}
Michael Yang's avatar
Michael Yang committed
700
		return
701
702
	}

Michael Yang's avatar
Michael Yang committed
703
704
705
706
707
	if resp.System != "" {
		tableRender("System", func() [][]string {
			return head(resp.System, 2)
		})
	}
708

Michael Yang's avatar
Michael Yang committed
709
710
711
712
	if resp.License != "" {
		tableRender("License", func() [][]string {
			return head(resp.License, 2)
		})
713
	}
Michael Yang's avatar
Michael Yang committed
714
715

	return nil
716
717
}

Patrick Devine's avatar
Patrick Devine committed
718
func CopyHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
719
	client, err := api.ClientFromEnvironment()
720
721
722
	if err != nil {
		return err
	}
Patrick Devine's avatar
Patrick Devine committed
723
724

	req := api.CopyRequest{Source: args[0], Destination: args[1]}
Michael Yang's avatar
Michael Yang committed
725
	if err := client.Copy(cmd.Context(), &req); err != nil {
Patrick Devine's avatar
Patrick Devine committed
726
727
728
729
730
731
		return err
	}
	fmt.Printf("copied '%s' to '%s'\n", args[0], args[1])
	return nil
}

732
func PullHandler(cmd *cobra.Command, args []string) error {
733
734
735
736
737
	insecure, err := cmd.Flags().GetBool("insecure")
	if err != nil {
		return err
	}

Michael Yang's avatar
Michael Yang committed
738
	client, err := api.ClientFromEnvironment()
739
740
741
	if err != nil {
		return err
	}
742

Michael Yang's avatar
Michael Yang committed
743
744
745
746
747
	p := progress.NewProgress(os.Stderr)
	defer p.Stop()

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

748
749
	var status string
	var spinner *progress.Spinner
Michael Yang's avatar
Michael Yang committed
750

751
	fn := func(resp api.ProgressResponse) error {
Michael Yang's avatar
Michael Yang committed
752
		if resp.Digest != "" {
753
754
755
			if spinner != nil {
				spinner.Stop()
			}
Michael Yang's avatar
Michael Yang committed
756
757
758

			bar, ok := bars[resp.Digest]
			if !ok {
759
				bar = progress.NewBar(fmt.Sprintf("pulling %s...", resp.Digest[7:19]), resp.Total, resp.Completed)
Michael Yang's avatar
Michael Yang committed
760
761
762
763
764
765
				bars[resp.Digest] = bar
				p.Add(resp.Digest, bar)
			}

			bar.Set(resp.Completed)
		} else if status != resp.Status {
766
767
768
			if spinner != nil {
				spinner.Stop()
			}
Michael Yang's avatar
Michael Yang committed
769
770
771
772
773
774

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

775
776
		return nil
	}
777

Michael Yang's avatar
Michael Yang committed
778
	request := api.PullRequest{Name: args[0], Insecure: insecure}
Michael Yang's avatar
Michael Yang committed
779
	if err := client.Pull(cmd.Context(), &request, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
780
781
782
783
		return err
	}

	return nil
Michael Yang's avatar
Michael Yang committed
784
785
}

786
787
type generateContextKey string

788
type runOptions struct {
789
790
791
792
793
794
795
796
797
798
	Model       string
	ParentModel string
	Prompt      string
	Messages    []api.Message
	WordWrap    bool
	Format      string
	System      string
	Images      []api.ImageData
	Options     map[string]interface{}
	MultiModal  bool
799
	KeepAlive   *api.Duration
800
801
}

802
803
804
805
806
807
808
809
810
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
811
812
			if state.lineLength+1 > termWidth-5 {
				if runewidth.StringWidth(state.wordBuffer) > termWidth-10 {
813
814
815
816
817
818
819
					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
820
821
				a := runewidth.StringWidth(state.wordBuffer)
				if a > 0 {
822
					fmt.Printf("\x1b[%dD", a)
823
824
				}
				fmt.Printf("\x1b[K\n")
825
				fmt.Printf("%s%c", state.wordBuffer, ch)
826
827
828
				chWidth := runewidth.RuneWidth(ch)

				state.lineLength = runewidth.StringWidth(state.wordBuffer) + chWidth
829
830
			} else {
				fmt.Print(string(ch))
831
832
833
834
				state.lineLength += runewidth.RuneWidth(ch)
				if runewidth.RuneWidth(ch) >= 2 {
					state.wordBuffer = ""
					continue
Josh Yan's avatar
Josh Yan committed
835
				}
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896

				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 = ""
		}
	}
}

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

	fn := func(response api.ChatResponse) error {
		p.StopAndClear()

		latest = response

		role = response.Message.Role
		content := response.Message.Content
		fullResponse.WriteString(content)

		displayResponse(content, opts.WordWrap, state)

		return nil
	}

897
898
899
900
	if opts.Format == "json" {
		opts.Format = `"` + opts.Format + `"`
	}

901
902
903
	req := &api.ChatRequest{
		Model:    opts.Model,
		Messages: opts.Messages,
904
		Format:   json.RawMessage(opts.Format),
905
906
907
		Options:  opts.Options,
	}

908
909
910
911
	if opts.KeepAlive != nil {
		req.KeepAlive = opts.KeepAlive
	}

912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
	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
937
	client, err := api.ClientFromEnvironment()
Patrick Devine's avatar
Patrick Devine committed
938
	if err != nil {
939
		return err
Patrick Devine's avatar
Patrick Devine committed
940
	}
Michael Yang's avatar
Michael Yang committed
941

Michael Yang's avatar
Michael Yang committed
942
	p := progress.NewProgress(os.Stderr)
943
	defer p.StopAndClear()
944

Michael Yang's avatar
Michael Yang committed
945
946
947
	spinner := progress.NewSpinner("")
	p.Add("", spinner)

948
949
950
951
952
953
954
	var latest api.GenerateResponse

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

Michael Yang's avatar
Michael Yang committed
955
	ctx, cancel := context.WithCancel(cmd.Context())
956
957
958
959
960
961
962
963
964
965
	defer cancel()

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

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

966
	var state *displayResponseState = &displayResponseState{}
967

968
	fn := func(response api.GenerateResponse) error {
Michael Yang's avatar
Michael Yang committed
969
		p.StopAndClear()
970

Patrick Devine's avatar
Patrick Devine committed
971
		latest = response
972
		content := response.Response
973

974
		displayResponse(content, opts.WordWrap, state)
975

Patrick Devine's avatar
Patrick Devine committed
976
977
		return nil
	}
978

979
980
981
982
983
984
985
	if opts.MultiModal {
		opts.Prompt, opts.Images, err = extractFileData(opts.Prompt)
		if err != nil {
			return err
		}
	}

986
987
988
989
	if opts.Format == "json" {
		opts.Format = `"` + opts.Format + `"`
	}

Michael Yang's avatar
Michael Yang committed
990
	request := api.GenerateRequest{
991
992
993
994
		Model:     opts.Model,
		Prompt:    opts.Prompt,
		Context:   generateContext,
		Images:    opts.Images,
995
		Format:    json.RawMessage(opts.Format),
996
997
998
		System:    opts.System,
		Options:   opts.Options,
		KeepAlive: opts.KeepAlive,
Michael Yang's avatar
Michael Yang committed
999
1000
1001
	}

	if err := client.Generate(ctx, &request, fn); err != nil {
1002
		if errors.Is(err, context.Canceled) {
1003
			return nil
1004
		}
1005
		return err
Patrick Devine's avatar
Patrick Devine committed
1006
	}
1007

1008
	if opts.Prompt != "" {
Michael Yang's avatar
Michael Yang committed
1009
1010
		fmt.Println()
		fmt.Println()
Patrick Devine's avatar
Patrick Devine committed
1011
	}
1012

1013
1014
1015
1016
	if !latest.Done {
		return nil
	}

Patrick Devine's avatar
Patrick Devine committed
1017
1018
	verbose, err := cmd.Flags().GetBool("verbose")
	if err != nil {
1019
		return err
Patrick Devine's avatar
Patrick Devine committed
1020
	}
Michael Yang's avatar
Michael Yang committed
1021

Patrick Devine's avatar
Patrick Devine committed
1022
1023
	if verbose {
		latest.Summary()
Michael Yang's avatar
Michael Yang committed
1024
	}
Michael Yang's avatar
Michael Yang committed
1025

Patrick Devine's avatar
Patrick Devine committed
1026
1027
1028
	ctx = context.WithValue(cmd.Context(), generateContextKey("context"), latest.Context)
	cmd.SetContext(ctx)

1029
	return nil
Michael Yang's avatar
Michael Yang committed
1030
1031
}

1032
func RunServer(_ *cobra.Command, _ []string) error {
Michael Yang's avatar
Michael Yang committed
1033
	if err := initializeKeypair(); err != nil {
1034
1035
1036
		return err
	}

Michael Yang's avatar
host  
Michael Yang committed
1037
	ln, err := net.Listen("tcp", envconfig.Host().Host)
1038
1039
1040
	if err != nil {
		return err
	}
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1041

1042
1043
1044
1045
1046
1047
	err = server.Serve(ln)
	if errors.Is(err, http.ErrServerClosed) {
		return nil
	}

	return err
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1048
1049
}

1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
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
1062
		cryptoPublicKey, cryptoPrivateKey, err := ed25519.GenerateKey(rand.Reader)
1063
1064
1065
1066
		if err != nil {
			return err
		}

Michael Yang's avatar
Michael Yang committed
1067
		privateKeyBytes, err := ssh.MarshalPrivateKey(cryptoPrivateKey, "")
1068
1069
1070
1071
		if err != nil {
			return err
		}

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

Michael Yang's avatar
Michael Yang committed
1076
		if err := os.WriteFile(privKeyPath, pem.EncodeToMemory(privateKeyBytes), 0o600); err != nil {
1077
1078
1079
			return err
		}

Michael Yang's avatar
Michael Yang committed
1080
		sshPublicKey, err := ssh.NewPublicKey(cryptoPublicKey)
1081
1082
1083
1084
		if err != nil {
			return err
		}

Michael Yang's avatar
Michael Yang committed
1085
		publicKeyBytes := ssh.MarshalAuthorizedKey(sshPublicKey)
1086

Michael Yang's avatar
Michael Yang committed
1087
		if err := os.WriteFile(pubKeyPath, publicKeyBytes, 0o644); err != nil {
1088
1089
1090
			return err
		}

Michael Yang's avatar
Michael Yang committed
1091
		fmt.Printf("Your new public key is: \n\n%s\n", publicKeyBytes)
1092
1093
1094
1095
	}
	return nil
}

Michael Yang's avatar
Michael Yang committed
1096
func checkServerHeartbeat(cmd *cobra.Command, _ []string) error {
Michael Yang's avatar
Michael Yang committed
1097
	client, err := api.ClientFromEnvironment()
1098
1099
1100
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
1101
	if err := client.Heartbeat(cmd.Context()); err != nil {
1102
		if !strings.Contains(err.Error(), " refused") {
Bruce MacDonald's avatar
Bruce MacDonald committed
1103
1104
			return err
		}
1105
		if err := startApp(cmd.Context(), client); err != nil {
Michael Yang's avatar
lint  
Michael Yang committed
1106
			return errors.New("could not connect to ollama app, is it running?")
1107
1108
1109
1110
1111
		}
	}
	return nil
}

Michael Yang's avatar
Michael Yang committed
1112
1113
1114
1115
1116
1117
1118
1119
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
1120
1121
1122
1123
1124
		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
1125
1126
	}

1127
	if serverVersion != version.Version {
Michael Yang's avatar
Michael Yang committed
1128
		fmt.Printf("Warning: client version is %s\n", version.Version)
1129
	}
Michael Yang's avatar
Michael Yang committed
1130
1131
}

1132
func appendEnvDocs(cmd *cobra.Command, envs []envconfig.EnvVar) {
1133
1134
1135
1136
1137
	if len(envs) == 0 {
		return
	}

	envUsage := `
1138
1139
Environment Variables:
`
1140
	for _, e := range envs {
1141
		envUsage += fmt.Sprintf("      %-24s   %s\n", e.Name, e.Description)
1142
1143
1144
	}

	cmd.SetUsageTemplate(cmd.UsageTemplate() + envUsage)
1145
1146
}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1147
1148
func NewCLI() *cobra.Command {
	log.SetFlags(log.LstdFlags | log.Lshortfile)
Michael Yang's avatar
Michael Yang committed
1149
	cobra.EnableCommandSorting = false
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1150

1151
	if runtime.GOOS == "windows" && term.IsTerminal(int(os.Stdout.Fd())) {
1152
		console.ConsoleFromFile(os.Stdin) //nolint:errcheck
1153
1154
	}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1155
	rootCmd := &cobra.Command{
1156
1157
1158
1159
		Use:           "ollama",
		Short:         "Large language model runner",
		SilenceUsage:  true,
		SilenceErrors: true,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1160
1161
1162
		CompletionOptions: cobra.CompletionOptions{
			DisableDefaultCmd: true,
		},
Michael Yang's avatar
Michael Yang committed
1163
1164
1165
1166
1167
1168
1169
1170
		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
1171
1172
	}

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

1175
	createCmd := &cobra.Command{
1176
1177
		Use:     "create MODEL",
		Short:   "Create a model from a Modelfile",
Michael Yang's avatar
Michael Yang committed
1178
		Args:    cobra.ExactArgs(1),
1179
1180
		PreRunE: checkServerHeartbeat,
		RunE:    CreateHandler,
1181
1182
	}

1183
	createCmd.Flags().StringP("file", "f", "", "Name of the Modelfile (default \"Modelfile\"")
1184
	createCmd.Flags().StringP("quantize", "q", "", "Quantize model to this level (e.g. q4_0)")
1185

Patrick Devine's avatar
Patrick Devine committed
1186
1187
1188
	showCmd := &cobra.Command{
		Use:     "show MODEL",
		Short:   "Show information for a model",
Michael Yang's avatar
Michael Yang committed
1189
		Args:    cobra.ExactArgs(1),
Patrick Devine's avatar
Patrick Devine committed
1190
1191
1192
1193
1194
1195
1196
1197
		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")
1198
	showCmd.Flags().Bool("system", false, "Show system message of a model")
Patrick Devine's avatar
Patrick Devine committed
1199

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1200
	runCmd := &cobra.Command{
1201
1202
1203
1204
1205
		Use:     "run MODEL [PROMPT]",
		Short:   "Run a model",
		Args:    cobra.MinimumNArgs(1),
		PreRunE: checkServerHeartbeat,
		RunE:    RunHandler,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1206
1207
	}

1208
	runCmd.Flags().String("keepalive", "", "Duration to keep a model loaded (e.g. 5m)")
1209
	runCmd.Flags().Bool("verbose", false, "Show timings for response")
1210
	runCmd.Flags().Bool("insecure", false, "Use an insecure registry")
1211
	runCmd.Flags().Bool("nowordwrap", false, "Don't wrap words to the next line automatically")
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1212
	runCmd.Flags().String("format", "", "Response format (e.g. json)")
Patrick Devine's avatar
Patrick Devine committed
1213
1214
1215
1216
1217
1218
1219
1220
1221

	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
1222
1223
1224
1225
	serveCmd := &cobra.Command{
		Use:     "serve",
		Aliases: []string{"start"},
		Short:   "Start ollama",
Michael Yang's avatar
Michael Yang committed
1226
		Args:    cobra.ExactArgs(0),
Michael Yang's avatar
Michael Yang committed
1227
		RunE:    RunServer,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1228
1229
	}

1230
	pullCmd := &cobra.Command{
1231
1232
		Use:     "pull MODEL",
		Short:   "Pull a model from a registry",
Michael Yang's avatar
Michael Yang committed
1233
		Args:    cobra.ExactArgs(1),
1234
1235
		PreRunE: checkServerHeartbeat,
		RunE:    PullHandler,
1236
1237
	}

1238
1239
	pullCmd.Flags().Bool("insecure", false, "Use an insecure registry")

1240
	pushCmd := &cobra.Command{
1241
1242
		Use:     "push MODEL",
		Short:   "Push a model to a registry",
Michael Yang's avatar
Michael Yang committed
1243
		Args:    cobra.ExactArgs(1),
1244
1245
		PreRunE: checkServerHeartbeat,
		RunE:    PushHandler,
1246
1247
	}

1248
1249
	pushCmd.Flags().Bool("insecure", false, "Use an insecure registry")

Patrick Devine's avatar
Patrick Devine committed
1250
	listCmd := &cobra.Command{
1251
		Use:     "list",
Patrick Devine's avatar
Patrick Devine committed
1252
		Aliases: []string{"ls"},
1253
		Short:   "List models",
1254
		PreRunE: checkServerHeartbeat,
1255
		RunE:    ListHandler,
1256
	}
1257
1258
1259
1260
1261
1262
1263
1264

	psCmd := &cobra.Command{
		Use:     "ps",
		Short:   "List running models",
		PreRunE: checkServerHeartbeat,
		RunE:    ListRunningHandler,
	}

Patrick Devine's avatar
Patrick Devine committed
1265
	copyCmd := &cobra.Command{
Michael Yang's avatar
Michael Yang committed
1266
		Use:     "cp SOURCE DESTINATION",
1267
		Short:   "Copy a model",
Michael Yang's avatar
Michael Yang committed
1268
		Args:    cobra.ExactArgs(2),
1269
1270
		PreRunE: checkServerHeartbeat,
		RunE:    CopyHandler,
Patrick Devine's avatar
Patrick Devine committed
1271
1272
	}

1273
	deleteCmd := &cobra.Command{
Michael Yang's avatar
Michael Yang committed
1274
		Use:     "rm MODEL [MODEL...]",
1275
1276
1277
1278
		Short:   "Remove a model",
		Args:    cobra.MinimumNArgs(1),
		PreRunE: checkServerHeartbeat,
		RunE:    DeleteHandler,
Patrick Devine's avatar
Patrick Devine committed
1279
1280
	}

1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
	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:])
	})

1293
1294
1295
	envVars := envconfig.AsMap()

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

1297
1298
1299
1300
	for _, cmd := range []*cobra.Command{
		createCmd,
		showCmd,
		runCmd,
Patrick Devine's avatar
Patrick Devine committed
1301
		stopCmd,
1302
1303
1304
		pullCmd,
		pushCmd,
		listCmd,
1305
		psCmd,
1306
1307
		copyCmd,
		deleteCmd,
1308
		serveCmd,
1309
	} {
1310
1311
		switch cmd {
		case runCmd:
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
			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"],
1324
				envVars["OLLAMA_SCHED_SPREAD"],
1325
				envVars["OLLAMA_TMPDIR"],
1326
				envVars["OLLAMA_FLASH_ATTENTION"],
1327
				envVars["OLLAMA_KV_CACHE_TYPE"],
1328
				envVars["OLLAMA_LLM_LIBRARY"],
1329
				envVars["OLLAMA_GPU_OVERHEAD"],
1330
				envVars["OLLAMA_LOAD_TIMEOUT"],
1331
			})
1332
1333
1334
		default:
			appendEnvDocs(cmd, envs)
		}
1335
1336
	}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1337
1338
	rootCmd.AddCommand(
		serveCmd,
1339
		createCmd,
Patrick Devine's avatar
Patrick Devine committed
1340
		showCmd,
1341
		runCmd,
Patrick Devine's avatar
Patrick Devine committed
1342
		stopCmd,
1343
1344
		pullCmd,
		pushCmd,
Patrick Devine's avatar
Patrick Devine committed
1345
		listCmd,
1346
		psCmd,
Patrick Devine's avatar
Patrick Devine committed
1347
		copyCmd,
1348
		deleteCmd,
1349
		runnerCmd,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1350
1351
1352
1353
	)

	return rootCmd
}