cmd.go 32.4 KB
Newer Older
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1
2
3
package cmd

import (
4
	"archive/zip"
Michael Yang's avatar
Michael Yang committed
5
	"bytes"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
6
	"context"
7
8
	"crypto/ed25519"
	"crypto/rand"
Michael Yang's avatar
Michael Yang committed
9
	"crypto/sha256"
10
	"encoding/pem"
Michael Yang's avatar
Michael Yang committed
11
	"errors"
Bruce MacDonald's avatar
Bruce MacDonald committed
12
	"fmt"
Michael Yang's avatar
Michael Yang committed
13
	"io"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
14
	"log"
15
	"math"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
16
	"net"
17
	"net/http"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
18
	"os"
19
	"os/signal"
20
	"path/filepath"
21
	"regexp"
22
	"runtime"
23
	"slices"
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/term"
Michael Yang's avatar
Michael Yang committed
35

36
	"github.com/ollama/ollama/api"
37
	"github.com/ollama/ollama/auth"
38
	"github.com/ollama/ollama/envconfig"
39
	"github.com/ollama/ollama/format"
40
	"github.com/ollama/ollama/parser"
41
42
	"github.com/ollama/ollama/progress"
	"github.com/ollama/ollama/server"
43
44
	"github.com/ollama/ollama/types/errtypes"
	"github.com/ollama/ollama/types/model"
45
	"github.com/ollama/ollama/version"
Jeffrey Morgan's avatar
Jeffrey Morgan committed
46
47
)

48
func CreateHandler(cmd *cobra.Command, args []string) error {
49
	filename, _ := cmd.Flags().GetString("file")
50
51
52
53
54
	filename, err := filepath.Abs(filename)
	if err != nil {
		return err
	}

Michael Yang's avatar
Michael Yang committed
55
	client, err := api.ClientFromEnvironment()
56
57
58
	if err != nil {
		return err
	}
59

Michael Yang's avatar
Michael Yang committed
60
61
62
	p := progress.NewProgress(os.Stderr)
	defer p.Stop()

Michael Yang's avatar
Michael Yang committed
63
	f, err := os.Open(filename)
Michael Yang's avatar
Michael Yang committed
64
65
66
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
67
	defer f.Close()
Michael Yang's avatar
Michael Yang committed
68

69
	modelfile, err := parser.ParseFile(f)
Michael Yang's avatar
Michael Yang committed
70
71
72
73
74
75
76
77
78
	if err != nil {
		return err
	}

	home, err := os.UserHomeDir()
	if err != nil {
		return err
	}

79
80
	status := "transferring model data"
	spinner := progress.NewSpinner(status)
81
	p.Add(status, spinner)
82
	defer p.Stop()
83

Michael Yang's avatar
Michael Yang committed
84
85
	for i := range modelfile.Commands {
		switch modelfile.Commands[i].Name {
Michael Yang's avatar
Michael Yang committed
86
		case "model", "adapter":
Michael Yang's avatar
Michael Yang committed
87
			path := modelfile.Commands[i].Args
Michael Yang's avatar
Michael Yang committed
88
89
90
91
92
93
			if path == "~" {
				path = home
			} else if strings.HasPrefix(path, "~/") {
				path = filepath.Join(home, path[2:])
			}

94
95
96
97
			if !filepath.IsAbs(path) {
				path = filepath.Join(filepath.Dir(filename), path)
			}

98
			fi, err := os.Stat(path)
Michael Yang's avatar
Michael Yang committed
99
			if errors.Is(err, os.ErrNotExist) && modelfile.Commands[i].Name == "model" {
Michael Yang's avatar
Michael Yang committed
100
				continue
Michael Yang's avatar
Michael Yang committed
101
102
103
104
			} else if err != nil {
				return err
			}

105
			if fi.IsDir() {
Michael Yang's avatar
Michael Yang committed
106
107
108
				// this is likely a safetensors or pytorch directory
				// TODO make this work w/ adapters
				tempfile, err := tempZipFiles(path)
109
110
111
				if err != nil {
					return err
				}
Michael Yang's avatar
Michael Yang committed
112
				defer os.RemoveAll(tempfile)
113

Michael Yang's avatar
Michael Yang committed
114
				path = tempfile
Michael Yang's avatar
Michael Yang committed
115
116
			}

117
			digest, err := createBlob(cmd, client, path, spinner)
118
			if err != nil {
Michael Yang's avatar
Michael Yang committed
119
120
121
				return err
			}

Michael Yang's avatar
Michael Yang committed
122
			modelfile.Commands[i].Args = "@" + digest
Michael Yang's avatar
Michael Yang committed
123
124
		}
	}
Michael Yang's avatar
Michael Yang committed
125

Michael Yang's avatar
Michael Yang committed
126
	bars := make(map[string]*progress.Bar)
127
	fn := func(resp api.ProgressResponse) error {
Michael Yang's avatar
Michael Yang committed
128
129
130
131
132
		if resp.Digest != "" {
			spinner.Stop()

			bar, ok := bars[resp.Digest]
			if !ok {
133
				bar = progress.NewBar(fmt.Sprintf("pulling %s...", resp.Digest[7:19]), resp.Total, resp.Completed)
Michael Yang's avatar
Michael Yang committed
134
135
136
137
138
139
140
141
142
143
144
145
146
				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)
		}

147
148
149
		return nil
	}

150
	quantize, _ := cmd.Flags().GetString("quantize")
Michael Yang's avatar
Michael Yang committed
151

152
	request := api.CreateRequest{Name: args[0], Modelfile: modelfile.String(), Quantize: quantize}
Michael Yang's avatar
Michael Yang committed
153
	if err := client.Create(cmd.Context(), &request, fn); err != nil {
154
155
156
157
158
159
		return err
	}

	return nil
}

Michael Yang's avatar
Michael Yang committed
160
161
162
163
164
165
166
func tempZipFiles(path string) (string, error) {
	tempfile, err := os.CreateTemp("", "ollama-tf")
	if err != nil {
		return "", err
	}
	defer tempfile.Close()

Michael Yang's avatar
Michael Yang committed
167
168
	detectContentType := func(path string) (string, error) {
		f, err := os.Open(path)
Michael Yang's avatar
Michael Yang committed
169
170
171
		if err != nil {
			return "", err
		}
Michael Yang's avatar
Michael Yang committed
172
		defer f.Close()
Michael Yang's avatar
Michael Yang committed
173

Michael Yang's avatar
Michael Yang committed
174
175
		var b bytes.Buffer
		b.Grow(512)
Michael Yang's avatar
Michael Yang committed
176

Michael Yang's avatar
Michael Yang committed
177
178
179
180
181
182
		if _, err := io.CopyN(&b, f, 512); err != nil && !errors.Is(err, io.EOF) {
			return "", err
		}

		contentType, _, _ := strings.Cut(http.DetectContentType(b.Bytes()), ";")
		return contentType, nil
Michael Yang's avatar
Michael Yang committed
183
184
	}

Michael Yang's avatar
Michael Yang committed
185
186
187
188
189
190
191
192
193
194
195
	glob := func(pattern, contentType string) ([]string, error) {
		matches, err := filepath.Glob(pattern)
		if err != nil {
			return nil, err
		}

		for _, safetensor := range matches {
			if ct, err := detectContentType(safetensor); err != nil {
				return nil, err
			} else if ct != contentType {
				return nil, fmt.Errorf("invalid content type: expected %s for %s", ct, safetensor)
Michael Yang's avatar
Michael Yang committed
196
			}
Michael Yang's avatar
Michael Yang committed
197
198
199
200
201
202
203
204
205
206
207
208
209
210
		}

		return matches, nil
	}

	var files []string
	if st, _ := glob(filepath.Join(path, "model*.safetensors"), "application/octet-stream"); len(st) > 0 {
		// safetensors files might be unresolved git lfs references; skip if they are
		// covers model-x-of-y.safetensors, model.fp32-x-of-y.safetensors, model.safetensors
		files = append(files, st...)
	} else if pt, _ := glob(filepath.Join(path, "pytorch_model*.bin"), "application/zip"); len(pt) > 0 {
		// pytorch files might also be unresolved git lfs references; skip if they are
		// covers pytorch_model-x-of-y.bin, pytorch_model.fp32-x-of-y.bin, pytorch_model.bin
		files = append(files, pt...)
Patrick Devine's avatar
Patrick Devine committed
211
	} else if pt, _ := glob(filepath.Join(path, "consolidated*.pth"), "application/zip"); len(pt) > 0 {
Michael Yang's avatar
Michael Yang committed
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
		// pytorch files might also be unresolved git lfs references; skip if they are
		// covers consolidated.x.pth, consolidated.pth
		files = append(files, pt...)
	} else {
		return "", errors.New("no safetensors or torch files found")
	}

	// add configuration files, json files are detected as text/plain
	js, err := glob(filepath.Join(path, "*.json"), "text/plain")
	if err != nil {
		return "", err
	}
	files = append(files, js...)

	if tks, _ := glob(filepath.Join(path, "tokenizer.model"), "application/octet-stream"); len(tks) > 0 {
		// add tokenizer.model if it exists, tokenizer.json is automatically picked up by the previous glob
		// tokenizer.model might be a unresolved git lfs reference; error if it is
		files = append(files, tks...)
	} else if tks, _ := glob(filepath.Join(path, "**/tokenizer.model"), "text/plain"); len(tks) > 0 {
		// some times tokenizer.model is in a subdirectory (e.g. meta-llama/Meta-Llama-3-8B)
		files = append(files, tks...)
	}

235
236
237
	zipfile := zip.NewWriter(tempfile)
	defer zipfile.Close()

Michael Yang's avatar
Michael Yang committed
238
239
240
	for _, file := range files {
		f, err := os.Open(file)
		if err != nil {
Michael Yang's avatar
Michael Yang committed
241
242
			return "", err
		}
Michael Yang's avatar
Michael Yang committed
243
		defer f.Close()
Michael Yang's avatar
Michael Yang committed
244
245
246
247
248
249

		fi, err := f.Stat()
		if err != nil {
			return "", err
		}

Michael Yang's avatar
Michael Yang committed
250
		zfi, err := zip.FileInfoHeader(fi)
Michael Yang's avatar
Michael Yang committed
251
252
253
254
		if err != nil {
			return "", err
		}

Michael Yang's avatar
Michael Yang committed
255
		zf, err := zipfile.CreateHeader(zfi)
Michael Yang's avatar
Michael Yang committed
256
257
258
259
		if err != nil {
			return "", err
		}

Michael Yang's avatar
Michael Yang committed
260
		if _, err := io.Copy(zf, f); err != nil {
Michael Yang's avatar
Michael Yang committed
261
262
263
264
265
266
267
			return "", err
		}
	}

	return tempfile.Name(), nil
}

268
func createBlob(cmd *cobra.Command, client *api.Client, path string, spinner *progress.Spinner) (string, error) {
269
270
271
272
273
274
	bin, err := os.Open(path)
	if err != nil {
		return "", err
	}
	defer bin.Close()

275
276
277
278
279
280
281
	// Get file info to retrieve the size
	fileInfo, err := bin.Stat()
	if err != nil {
		return "", err
	}
	fileSize := fileInfo.Size()

282
283
284
285
	hash := sha256.New()
	if _, err := io.Copy(hash, bin); err != nil {
		return "", err
	}
286
287
288
289

	if _, err := bin.Seek(0, io.SeekStart); err != nil {
		return "", err
	}
290

291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
	var pw progressWriter
	status := "transferring model data 0%"
	spinner.SetMessage(status)

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

	go func() {
		ticker := time.NewTicker(60 * time.Millisecond)
		defer ticker.Stop()
		for {
			select {
			case <-ticker.C:
				spinner.SetMessage(fmt.Sprintf("transferring model data %d%%", int(100*pw.n.Load()/fileSize)))
			case <-done:
				spinner.SetMessage("transferring model data 100%")
				return
			}
		}
	}()

312
	digest := fmt.Sprintf("sha256:%x", hash.Sum(nil))
313
	if err = client.CreateBlob(cmd.Context(), digest, io.TeeReader(bin, &pw)); err != nil {
314
315
316
317
318
		return "", err
	}
	return digest, nil
}

319
320
321
322
323
324
325
326
327
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
}

328
func RunHandler(cmd *cobra.Command, args []string) error {
329
330
331
	interactive := true

	opts := runOptions{
332
333
334
		Model:    args[0],
		WordWrap: os.Getenv("TERM") == "xterm-256color",
		Options:  map[string]interface{}{},
335
336
337
338
339
340
341
342
	}

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

343
344
345
346
347
348
349
350
351
352
353
354
	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}
	}

355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
	prompts := args[1:]
	// prepend stdin to the prompt if provided
	if !term.IsTerminal(int(os.Stdin.Fd())) {
		in, err := io.ReadAll(os.Stdin)
		if err != nil {
			return err
		}

		prompts = append([]string{string(in)}, prompts...)
		opts.WordWrap = false
		interactive = false
	}
	opts.Prompt = strings.Join(prompts, " ")
	if len(prompts) > 0 {
		interactive = false
	}

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

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

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

402
403
404
405
	opts.MultiModal = slices.Contains(info.Details.Families, "clip")
	opts.ParentModel = info.Details.ParentModel

	if interactive {
Michael Yang's avatar
Michael Yang committed
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
		if err := loadModel(cmd, &opts); err != nil {
			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()
			}
		}

422
423
424
		return generateInteractive(cmd, opts)
	}
	return generate(cmd, opts)
Bruce MacDonald's avatar
Bruce MacDonald committed
425
426
}

427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
func errFromUnknownKey(unknownKeyErr error) error {
	// find SSH public key in the error message
	sshKeyPattern := `ssh-\w+ [^\s"]+`
	re := regexp.MustCompile(sshKeyPattern)
	matches := re.FindStringSubmatch(unknownKeyErr.Error())

	if len(matches) > 0 {
		serverPubKey := matches[0]

		localPubKey, err := auth.GetPublicKey()
		if err != nil {
			return unknownKeyErr
		}

		if runtime.GOOS == "linux" && serverPubKey != localPubKey {
			// try the ollama service public key
			svcPubKey, err := os.ReadFile("/usr/share/ollama/.ollama/id_ed25519.pub")
			if err != nil {
				return unknownKeyErr
			}
			localPubKey = strings.TrimSpace(string(svcPubKey))
		}

		// check if the returned public key matches the local public key, this prevents adding a remote key to the user's account
		if serverPubKey != localPubKey {
			return unknownKeyErr
		}

		var msg strings.Builder
		msg.WriteString(unknownKeyErr.Error())
		msg.WriteString("\n\nYour ollama key is:\n")
		msg.WriteString(localPubKey)
		msg.WriteString("\nAdd your key at:\n")
		msg.WriteString("https://ollama.com/settings/keys")

		return errors.New(msg.String())
	}

	return unknownKeyErr
}

468
func PushHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
469
	client, err := api.ClientFromEnvironment()
470
471
472
	if err != nil {
		return err
	}
473

474
475
476
477
478
	insecure, err := cmd.Flags().GetBool("insecure")
	if err != nil {
		return err
	}

Michael Yang's avatar
Michael Yang committed
479
480
481
482
	p := progress.NewProgress(os.Stderr)
	defer p.Stop()

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

486
	fn := func(resp api.ProgressResponse) error {
Michael Yang's avatar
Michael Yang committed
487
		if resp.Digest != "" {
488
489
490
			if spinner != nil {
				spinner.Stop()
			}
Michael Yang's avatar
Michael Yang committed
491
492
493

			bar, ok := bars[resp.Digest]
			if !ok {
494
				bar = progress.NewBar(fmt.Sprintf("pushing %s...", resp.Digest[7:19]), resp.Total, resp.Completed)
Michael Yang's avatar
Michael Yang committed
495
496
497
498
499
500
				bars[resp.Digest] = bar
				p.Add(resp.Digest, bar)
			}

			bar.Set(resp.Completed)
		} else if status != resp.Status {
501
502
503
			if spinner != nil {
				spinner.Stop()
			}
Michael Yang's avatar
Michael Yang committed
504
505
506
507
508
509

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

510
511
512
		return nil
	}

Michael Yang's avatar
Michael Yang committed
513
	request := api.PushRequest{Name: args[0], Insecure: insecure}
Michael Yang's avatar
Michael Yang committed
514
	if err := client.Push(cmd.Context(), &request, fn); err != nil {
515
516
517
518
519
520
521
522
523
524
525
526
527
528
		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")
		}
		host := model.ParseName(args[0]).Host
		isOllamaHost := strings.HasSuffix(host, ".ollama.ai") || strings.HasSuffix(host, ".ollama.com")
		if strings.Contains(err.Error(), errtypes.UnknownOllamaKeyErrMsg) && isOllamaHost {
			// the user has not added their ollama key to ollama.com
			// re-throw an error with a more user-friendly message
			return errFromUnknownKey(err)
		}

Michael Yang's avatar
Michael Yang committed
529
530
531
		return err
	}

532
	spinner.Stop()
Michael Yang's avatar
Michael Yang committed
533
	return nil
534
535
}

536
func ListHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
537
	client, err := api.ClientFromEnvironment()
538
539
540
	if err != nil {
		return err
	}
Patrick Devine's avatar
Patrick Devine committed
541

Michael Yang's avatar
Michael Yang committed
542
	models, err := client.List(cmd.Context())
Patrick Devine's avatar
Patrick Devine committed
543
544
545
546
547
548
549
	if err != nil {
		return err
	}

	var data [][]string

	for _, m := range models.Models {
Michael Yang's avatar
Michael Yang committed
550
		if len(args) == 0 || strings.HasPrefix(m.Name, args[0]) {
551
			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
552
		}
Patrick Devine's avatar
Patrick Devine committed
553
554
555
	}

	table := tablewriter.NewWriter(os.Stdout)
Patrick Devine's avatar
Patrick Devine committed
556
	table.SetHeader([]string{"NAME", "ID", "SIZE", "MODIFIED"})
Patrick Devine's avatar
Patrick Devine committed
557
558
559
560
561
562
563
564
565
566
567
568
	table.SetHeaderAlignment(tablewriter.ALIGN_LEFT)
	table.SetAlignment(tablewriter.ALIGN_LEFT)
	table.SetHeaderLine(false)
	table.SetBorder(false)
	table.SetNoWhiteSpace(true)
	table.SetTablePadding("\t")
	table.AppendBulk(data)
	table.Render()

	return nil
}

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
607
608
609
610
611
612
613
614
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))
			}
			data = append(data, []string{m.Name, m.Digest[:12], format.HumanBytes(m.Size), procStr, format.HumanTime(m.ExpiresAt, "Never")})
		}
	}

	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)
	table.SetTablePadding("\t")
	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
	for _, name := range args {
		req := api.DeleteRequest{Name: name}
Michael Yang's avatar
Michael Yang committed
623
		if err := client.Delete(cmd.Context(), &req); err != nil {
624
625
626
			return err
		}
		fmt.Printf("deleted '%s'\n", name)
627
628
629
630
	}
	return nil
}

Patrick Devine's avatar
Patrick Devine committed
631
func ShowHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
632
	client, err := api.ClientFromEnvironment()
Patrick Devine's avatar
Patrick Devine committed
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
	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 {
678
		return errors.New("only one of '--license', '--modelfile', '--parameters', '--system', or '--template' can be specified")
679
680
	}

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

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

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

704
	showInfo(resp)
Patrick Devine's avatar
Patrick Devine committed
705

706
707
708
709
	return nil
}

func showInfo(resp *api.ShowResponse) {
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
	arch := resp.ModelInfo["general.architecture"].(string)

	modelData := [][]string{
		{"arch", arch},
		{"parameters", resp.Details.ParameterSize},
		{"quantization", resp.Details.QuantizationLevel},
		{"context length", fmt.Sprintf("%v", resp.ModelInfo[fmt.Sprintf("%s.context_length", arch)].(float64))},
		{"embedding length", fmt.Sprintf("%v", resp.ModelInfo[fmt.Sprintf("%s.embedding_length", arch)].(float64))},
	}

	mainTableData := [][]string{
		{"Model"},
		{renderSubTable(modelData, false)},
	}

	if resp.ProjectorInfo != nil {
		projectorData := [][]string{
			{"arch", "clip"},
			{"parameters", format.HumanNumber(uint64(resp.ProjectorInfo["general.parameter_count"].(float64)))},
		}

731
732
733
734
735
736
737
738
739
		if projectorType, ok := resp.ProjectorInfo["clip.projector_type"]; ok {
			projectorData = append(projectorData, []string{"projector type", projectorType.(string)})
		}

		projectorData = append(projectorData,
			[]string{"embedding length", fmt.Sprintf("%v", resp.ProjectorInfo["clip.vision.embedding_length"].(float64))},
			[]string{"projection dimensionality", fmt.Sprintf("%v", resp.ProjectorInfo["clip.vision.projection_dim"].(float64))},
		)

740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
		mainTableData = append(mainTableData,
			[]string{"Projector"},
			[]string{renderSubTable(projectorData, false)},
		)
	}

	if resp.Parameters != "" {
		mainTableData = append(mainTableData, []string{"Parameters"}, []string{formatParams(resp.Parameters)})
	}

	if resp.System != "" {
		mainTableData = append(mainTableData, []string{"System"}, []string{renderSubTable(twoLines(resp.System), true)})
	}

	if resp.License != "" {
		mainTableData = append(mainTableData, []string{"License"}, []string{renderSubTable(twoLines(resp.License), true)})
	}

	table := tablewriter.NewWriter(os.Stdout)
	table.SetAutoWrapText(false)
	table.SetBorder(false)
	table.SetAlignment(tablewriter.ALIGN_LEFT)

	for _, v := range mainTableData {
		table.Append(v)
Patrick Devine's avatar
Patrick Devine committed
765
766
	}

767
	table.Render()
Patrick Devine's avatar
Patrick Devine committed
768
769
}

770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
func renderSubTable(data [][]string, file bool) string {
	var buf bytes.Buffer
	table := tablewriter.NewWriter(&buf)
	table.SetAutoWrapText(!file)
	table.SetBorder(false)
	table.SetNoWhiteSpace(true)
	table.SetTablePadding("\t")
	table.SetAlignment(tablewriter.ALIGN_LEFT)

	for _, v := range data {
		table.Append(v)
	}

	table.Render()

	renderedTable := buf.String()
	lines := strings.Split(renderedTable, "\n")
	for i, line := range lines {
		lines[i] = "\t" + line
	}

	return strings.Join(lines, "\n")
}

func twoLines(s string) [][]string {
	lines := strings.Split(s, "\n")
	res := [][]string{}

	count := 0
	for _, line := range lines {
		line = strings.TrimSpace(line)
		if line != "" {
			count++
			res = append(res, []string{line})
			if count == 2 {
				return res
			}
		}
	}
	return res
}

func formatParams(s string) string {
	lines := strings.Split(s, "\n")
	table := [][]string{}

	for _, line := range lines {
		table = append(table, strings.Fields(line))
	}
	return renderSubTable(table, false)
}

Patrick Devine's avatar
Patrick Devine committed
822
func CopyHandler(cmd *cobra.Command, args []string) error {
Michael Yang's avatar
Michael Yang committed
823
	client, err := api.ClientFromEnvironment()
824
825
826
	if err != nil {
		return err
	}
Patrick Devine's avatar
Patrick Devine committed
827
828

	req := api.CopyRequest{Source: args[0], Destination: args[1]}
Michael Yang's avatar
Michael Yang committed
829
	if err := client.Copy(cmd.Context(), &req); err != nil {
Patrick Devine's avatar
Patrick Devine committed
830
831
832
833
834
835
		return err
	}
	fmt.Printf("copied '%s' to '%s'\n", args[0], args[1])
	return nil
}

836
func PullHandler(cmd *cobra.Command, args []string) error {
837
838
839
840
841
	insecure, err := cmd.Flags().GetBool("insecure")
	if err != nil {
		return err
	}

Michael Yang's avatar
Michael Yang committed
842
	client, err := api.ClientFromEnvironment()
843
844
845
	if err != nil {
		return err
	}
846

Michael Yang's avatar
Michael Yang committed
847
848
849
850
851
	p := progress.NewProgress(os.Stderr)
	defer p.Stop()

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

852
853
	var status string
	var spinner *progress.Spinner
Michael Yang's avatar
Michael Yang committed
854

855
	fn := func(resp api.ProgressResponse) error {
Michael Yang's avatar
Michael Yang committed
856
		if resp.Digest != "" {
857
858
859
			if spinner != nil {
				spinner.Stop()
			}
Michael Yang's avatar
Michael Yang committed
860
861
862

			bar, ok := bars[resp.Digest]
			if !ok {
863
				bar = progress.NewBar(fmt.Sprintf("pulling %s...", resp.Digest[7:19]), resp.Total, resp.Completed)
Michael Yang's avatar
Michael Yang committed
864
865
866
867
868
869
				bars[resp.Digest] = bar
				p.Add(resp.Digest, bar)
			}

			bar.Set(resp.Completed)
		} else if status != resp.Status {
870
871
872
			if spinner != nil {
				spinner.Stop()
			}
Michael Yang's avatar
Michael Yang committed
873
874
875
876
877
878

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

879
880
		return nil
	}
881

Michael Yang's avatar
Michael Yang committed
882
	request := api.PullRequest{Name: args[0], Insecure: insecure}
Michael Yang's avatar
Michael Yang committed
883
	if err := client.Pull(cmd.Context(), &request, fn); err != nil {
Michael Yang's avatar
Michael Yang committed
884
885
886
887
		return err
	}

	return nil
Michael Yang's avatar
Michael Yang committed
888
889
}

890
891
type generateContextKey string

892
type runOptions struct {
893
894
895
896
897
898
899
900
901
902
	Model       string
	ParentModel string
	Prompt      string
	Messages    []api.Message
	WordWrap    bool
	Format      string
	System      string
	Images      []api.ImageData
	Options     map[string]interface{}
	MultiModal  bool
903
	KeepAlive   *api.Duration
904
905
}

906
907
908
909
910
911
912
913
914
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
915
916
			if state.lineLength+1 > termWidth-5 {
				if runewidth.StringWidth(state.wordBuffer) > termWidth-10 {
917
918
919
920
921
922
923
					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
924
925
				a := runewidth.StringWidth(state.wordBuffer)
				if a > 0 {
926
					fmt.Printf("\x1b[%dD", a)
927
928
				}
				fmt.Printf("\x1b[K\n")
929
				fmt.Printf("%s%c", state.wordBuffer, ch)
930
931
932
				chWidth := runewidth.RuneWidth(ch)

				state.lineLength = runewidth.StringWidth(state.wordBuffer) + chWidth
933
934
			} else {
				fmt.Print(string(ch))
935
936
937
938
				state.lineLength += runewidth.RuneWidth(ch)
				if runewidth.RuneWidth(ch) >= 2 {
					state.wordBuffer = ""
					continue
Josh Yan's avatar
Josh Yan committed
939
				}
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007

				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
	}

	req := &api.ChatRequest{
		Model:    opts.Model,
		Messages: opts.Messages,
		Format:   opts.Format,
		Options:  opts.Options,
	}

1008
1009
1010
1011
	if opts.KeepAlive != nil {
		req.KeepAlive = opts.KeepAlive
	}

1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
	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
1037
	client, err := api.ClientFromEnvironment()
Patrick Devine's avatar
Patrick Devine committed
1038
	if err != nil {
1039
		return err
Patrick Devine's avatar
Patrick Devine committed
1040
	}
Michael Yang's avatar
Michael Yang committed
1041

Michael Yang's avatar
Michael Yang committed
1042
	p := progress.NewProgress(os.Stderr)
1043
	defer p.StopAndClear()
1044

Michael Yang's avatar
Michael Yang committed
1045
1046
1047
	spinner := progress.NewSpinner("")
	p.Add("", spinner)

1048
1049
1050
1051
1052
1053
1054
	var latest api.GenerateResponse

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

Michael Yang's avatar
Michael Yang committed
1055
	ctx, cancel := context.WithCancel(cmd.Context())
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
	defer cancel()

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

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

1066
	var state *displayResponseState = &displayResponseState{}
1067

1068
	fn := func(response api.GenerateResponse) error {
Michael Yang's avatar
Michael Yang committed
1069
		p.StopAndClear()
1070

Patrick Devine's avatar
Patrick Devine committed
1071
		latest = response
1072
		content := response.Response
1073

1074
		displayResponse(content, opts.WordWrap, state)
1075

Patrick Devine's avatar
Patrick Devine committed
1076
1077
		return nil
	}
1078

1079
1080
1081
1082
1083
1084
1085
	if opts.MultiModal {
		opts.Prompt, opts.Images, err = extractFileData(opts.Prompt)
		if err != nil {
			return err
		}
	}

Michael Yang's avatar
Michael Yang committed
1086
	request := api.GenerateRequest{
1087
1088
1089
1090
1091
1092
1093
1094
		Model:     opts.Model,
		Prompt:    opts.Prompt,
		Context:   generateContext,
		Images:    opts.Images,
		Format:    opts.Format,
		System:    opts.System,
		Options:   opts.Options,
		KeepAlive: opts.KeepAlive,
Michael Yang's avatar
Michael Yang committed
1095
1096
1097
	}

	if err := client.Generate(ctx, &request, fn); err != nil {
1098
		if errors.Is(err, context.Canceled) {
1099
			return nil
1100
		}
1101
		return err
Patrick Devine's avatar
Patrick Devine committed
1102
	}
1103

1104
	if opts.Prompt != "" {
Michael Yang's avatar
Michael Yang committed
1105
1106
		fmt.Println()
		fmt.Println()
Patrick Devine's avatar
Patrick Devine committed
1107
	}
1108

1109
1110
1111
1112
	if !latest.Done {
		return nil
	}

Patrick Devine's avatar
Patrick Devine committed
1113
1114
	verbose, err := cmd.Flags().GetBool("verbose")
	if err != nil {
1115
		return err
Patrick Devine's avatar
Patrick Devine committed
1116
	}
Michael Yang's avatar
Michael Yang committed
1117

Patrick Devine's avatar
Patrick Devine committed
1118
1119
	if verbose {
		latest.Summary()
Michael Yang's avatar
Michael Yang committed
1120
	}
Michael Yang's avatar
Michael Yang committed
1121

Patrick Devine's avatar
Patrick Devine committed
1122
1123
1124
	ctx = context.WithValue(cmd.Context(), generateContextKey("context"), latest.Context)
	cmd.SetContext(ctx)

1125
	return nil
Michael Yang's avatar
Michael Yang committed
1126
1127
}

1128
func RunServer(cmd *cobra.Command, _ []string) error {
Michael Yang's avatar
Michael Yang committed
1129
	if err := initializeKeypair(); err != nil {
1130
1131
1132
		return err
	}

Michael Yang's avatar
host  
Michael Yang committed
1133
	ln, err := net.Listen("tcp", envconfig.Host().Host)
1134
1135
1136
	if err != nil {
		return err
	}
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1137

1138
1139
1140
1141
1142
1143
	err = server.Serve(ln)
	if errors.Is(err, http.ErrServerClosed) {
		return nil
	}

	return err
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1144
1145
}

1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
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
1158
		cryptoPublicKey, cryptoPrivateKey, err := ed25519.GenerateKey(rand.Reader)
1159
1160
1161
1162
		if err != nil {
			return err
		}

Michael Yang's avatar
Michael Yang committed
1163
		privateKeyBytes, err := ssh.MarshalPrivateKey(cryptoPrivateKey, "")
1164
1165
1166
1167
		if err != nil {
			return err
		}

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

Michael Yang's avatar
Michael Yang committed
1172
		if err := os.WriteFile(privKeyPath, pem.EncodeToMemory(privateKeyBytes), 0o600); err != nil {
1173
1174
1175
			return err
		}

Michael Yang's avatar
Michael Yang committed
1176
		sshPublicKey, err := ssh.NewPublicKey(cryptoPublicKey)
1177
1178
1179
1180
		if err != nil {
			return err
		}

Michael Yang's avatar
Michael Yang committed
1181
		publicKeyBytes := ssh.MarshalAuthorizedKey(sshPublicKey)
1182

Michael Yang's avatar
Michael Yang committed
1183
		if err := os.WriteFile(pubKeyPath, publicKeyBytes, 0o644); err != nil {
1184
1185
1186
			return err
		}

Michael Yang's avatar
Michael Yang committed
1187
		fmt.Printf("Your new public key is: \n\n%s\n", publicKeyBytes)
1188
1189
1190
1191
	}
	return nil
}

Michael Yang's avatar
Michael Yang committed
1192
func checkServerHeartbeat(cmd *cobra.Command, _ []string) error {
Michael Yang's avatar
Michael Yang committed
1193
	client, err := api.ClientFromEnvironment()
1194
1195
1196
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
1197
	if err := client.Heartbeat(cmd.Context()); err != nil {
1198
		if !strings.Contains(err.Error(), " refused") {
Bruce MacDonald's avatar
Bruce MacDonald committed
1199
1200
			return err
		}
1201
		if err := startApp(cmd.Context(), client); err != nil {
Michael Yang's avatar
lint  
Michael Yang committed
1202
			return errors.New("could not connect to ollama app, is it running?")
1203
1204
1205
1206
1207
		}
	}
	return nil
}

Michael Yang's avatar
Michael Yang committed
1208
1209
1210
1211
1212
1213
1214
1215
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
1216
1217
1218
1219
1220
		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
1221
1222
	}

1223
	if serverVersion != version.Version {
Michael Yang's avatar
Michael Yang committed
1224
		fmt.Printf("Warning: client version is %s\n", version.Version)
1225
	}
Michael Yang's avatar
Michael Yang committed
1226
1227
}

1228
func appendEnvDocs(cmd *cobra.Command, envs []envconfig.EnvVar) {
1229
1230
1231
1232
1233
	if len(envs) == 0 {
		return
	}

	envUsage := `
1234
1235
Environment Variables:
`
1236
	for _, e := range envs {
1237
		envUsage += fmt.Sprintf("      %-24s   %s\n", e.Name, e.Description)
1238
1239
1240
	}

	cmd.SetUsageTemplate(cmd.UsageTemplate() + envUsage)
1241
1242
}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1243
1244
func NewCLI() *cobra.Command {
	log.SetFlags(log.LstdFlags | log.Lshortfile)
Michael Yang's avatar
Michael Yang committed
1245
	cobra.EnableCommandSorting = false
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1246

1247
	if runtime.GOOS == "windows" {
1248
		console.ConsoleFromFile(os.Stdin) //nolint:errcheck
1249
1250
	}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1251
	rootCmd := &cobra.Command{
1252
1253
1254
1255
		Use:           "ollama",
		Short:         "Large language model runner",
		SilenceUsage:  true,
		SilenceErrors: true,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1256
1257
1258
		CompletionOptions: cobra.CompletionOptions{
			DisableDefaultCmd: true,
		},
Michael Yang's avatar
Michael Yang committed
1259
1260
1261
1262
1263
1264
1265
1266
		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
1267
1268
	}

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

1271
	createCmd := &cobra.Command{
1272
1273
		Use:     "create MODEL",
		Short:   "Create a model from a Modelfile",
Michael Yang's avatar
Michael Yang committed
1274
		Args:    cobra.ExactArgs(1),
1275
1276
		PreRunE: checkServerHeartbeat,
		RunE:    CreateHandler,
1277
1278
	}

1279
	createCmd.Flags().StringP("file", "f", "Modelfile", "Name of the Modelfile")
1280
	createCmd.Flags().StringP("quantize", "q", "", "Quantize model to this level (e.g. q4_0)")
1281

Patrick Devine's avatar
Patrick Devine committed
1282
1283
1284
	showCmd := &cobra.Command{
		Use:     "show MODEL",
		Short:   "Show information for a model",
Michael Yang's avatar
Michael Yang committed
1285
		Args:    cobra.ExactArgs(1),
Patrick Devine's avatar
Patrick Devine committed
1286
1287
1288
1289
1290
1291
1292
1293
		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")
1294
	showCmd.Flags().Bool("system", false, "Show system message of a model")
Patrick Devine's avatar
Patrick Devine committed
1295

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1296
	runCmd := &cobra.Command{
1297
1298
1299
1300
1301
		Use:     "run MODEL [PROMPT]",
		Short:   "Run a model",
		Args:    cobra.MinimumNArgs(1),
		PreRunE: checkServerHeartbeat,
		RunE:    RunHandler,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1302
1303
	}

1304
	runCmd.Flags().String("keepalive", "", "Duration to keep a model loaded (e.g. 5m)")
1305
	runCmd.Flags().Bool("verbose", false, "Show timings for response")
1306
	runCmd.Flags().Bool("insecure", false, "Use an insecure registry")
1307
	runCmd.Flags().Bool("nowordwrap", false, "Don't wrap words to the next line automatically")
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1308
	runCmd.Flags().String("format", "", "Response format (e.g. json)")
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1309
1310
1311
1312
	serveCmd := &cobra.Command{
		Use:     "serve",
		Aliases: []string{"start"},
		Short:   "Start ollama",
Michael Yang's avatar
Michael Yang committed
1313
		Args:    cobra.ExactArgs(0),
Michael Yang's avatar
Michael Yang committed
1314
		RunE:    RunServer,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1315
1316
	}

1317
	pullCmd := &cobra.Command{
1318
1319
		Use:     "pull MODEL",
		Short:   "Pull a model from a registry",
Michael Yang's avatar
Michael Yang committed
1320
		Args:    cobra.ExactArgs(1),
1321
1322
		PreRunE: checkServerHeartbeat,
		RunE:    PullHandler,
1323
1324
	}

1325
1326
	pullCmd.Flags().Bool("insecure", false, "Use an insecure registry")

1327
	pushCmd := &cobra.Command{
1328
1329
		Use:     "push MODEL",
		Short:   "Push a model to a registry",
Michael Yang's avatar
Michael Yang committed
1330
		Args:    cobra.ExactArgs(1),
1331
1332
		PreRunE: checkServerHeartbeat,
		RunE:    PushHandler,
1333
1334
	}

1335
1336
	pushCmd.Flags().Bool("insecure", false, "Use an insecure registry")

Patrick Devine's avatar
Patrick Devine committed
1337
	listCmd := &cobra.Command{
1338
		Use:     "list",
Patrick Devine's avatar
Patrick Devine committed
1339
		Aliases: []string{"ls"},
1340
		Short:   "List models",
1341
		PreRunE: checkServerHeartbeat,
1342
		RunE:    ListHandler,
1343
	}
1344
1345
1346
1347
1348
1349
1350
1351

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

Patrick Devine's avatar
Patrick Devine committed
1352
	copyCmd := &cobra.Command{
Michael Yang's avatar
Michael Yang committed
1353
		Use:     "cp SOURCE DESTINATION",
1354
		Short:   "Copy a model",
Michael Yang's avatar
Michael Yang committed
1355
		Args:    cobra.ExactArgs(2),
1356
1357
		PreRunE: checkServerHeartbeat,
		RunE:    CopyHandler,
Patrick Devine's avatar
Patrick Devine committed
1358
1359
	}

1360
	deleteCmd := &cobra.Command{
Michael Yang's avatar
Michael Yang committed
1361
		Use:     "rm MODEL [MODEL...]",
1362
1363
1364
1365
		Short:   "Remove a model",
		Args:    cobra.MinimumNArgs(1),
		PreRunE: checkServerHeartbeat,
		RunE:    DeleteHandler,
Patrick Devine's avatar
Patrick Devine committed
1366
1367
	}

1368
1369
1370
	envVars := envconfig.AsMap()

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

1372
1373
1374
1375
1376
1377
1378
	for _, cmd := range []*cobra.Command{
		createCmd,
		showCmd,
		runCmd,
		pullCmd,
		pushCmd,
		listCmd,
1379
		psCmd,
1380
1381
		copyCmd,
		deleteCmd,
1382
		serveCmd,
1383
	} {
1384
1385
		switch cmd {
		case runCmd:
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
			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"],
1398
				envVars["OLLAMA_SCHED_SPREAD"],
1399
				envVars["OLLAMA_TMPDIR"],
1400
1401
				envVars["OLLAMA_FLASH_ATTENTION"],
				envVars["OLLAMA_LLM_LIBRARY"],
1402
			})
1403
1404
1405
		default:
			appendEnvDocs(cmd, envs)
		}
1406
1407
	}

Jeffrey Morgan's avatar
Jeffrey Morgan committed
1408
1409
	rootCmd.AddCommand(
		serveCmd,
1410
		createCmd,
Patrick Devine's avatar
Patrick Devine committed
1411
		showCmd,
1412
		runCmd,
1413
1414
		pullCmd,
		pushCmd,
Patrick Devine's avatar
Patrick Devine committed
1415
		listCmd,
1416
		psCmd,
Patrick Devine's avatar
Patrick Devine committed
1417
		copyCmd,
1418
		deleteCmd,
Jeffrey Morgan's avatar
Jeffrey Morgan committed
1419
1420
1421
1422
	)

	return rootCmd
}