cmd.go 31 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354
  1. package cmd
  2. import (
  3. "archive/zip"
  4. "bytes"
  5. "context"
  6. "crypto/ed25519"
  7. "crypto/rand"
  8. "crypto/sha256"
  9. "encoding/pem"
  10. "errors"
  11. "fmt"
  12. "io"
  13. "log"
  14. "math"
  15. "net"
  16. "net/http"
  17. "os"
  18. "os/signal"
  19. "path/filepath"
  20. "regexp"
  21. "runtime"
  22. "slices"
  23. "strings"
  24. "syscall"
  25. "time"
  26. "github.com/containerd/console"
  27. "github.com/mattn/go-runewidth"
  28. "github.com/olekukonko/tablewriter"
  29. "github.com/spf13/cobra"
  30. "golang.org/x/crypto/ssh"
  31. "golang.org/x/term"
  32. "github.com/ollama/ollama/api"
  33. "github.com/ollama/ollama/auth"
  34. "github.com/ollama/ollama/envconfig"
  35. "github.com/ollama/ollama/format"
  36. "github.com/ollama/ollama/parser"
  37. "github.com/ollama/ollama/progress"
  38. "github.com/ollama/ollama/server"
  39. "github.com/ollama/ollama/types/errtypes"
  40. "github.com/ollama/ollama/types/model"
  41. "github.com/ollama/ollama/version"
  42. )
  43. func CreateHandler(cmd *cobra.Command, args []string) error {
  44. filename, _ := cmd.Flags().GetString("file")
  45. filename, err := filepath.Abs(filename)
  46. if err != nil {
  47. return err
  48. }
  49. client, err := api.ClientFromEnvironment()
  50. if err != nil {
  51. return err
  52. }
  53. p := progress.NewProgress(os.Stderr)
  54. defer p.Stop()
  55. f, err := os.Open(filename)
  56. if err != nil {
  57. return err
  58. }
  59. defer f.Close()
  60. modelfile, err := parser.ParseFile(f)
  61. if err != nil {
  62. return err
  63. }
  64. home, err := os.UserHomeDir()
  65. if err != nil {
  66. return err
  67. }
  68. status := "transferring model data"
  69. spinner := progress.NewSpinner(status)
  70. p.Add(status, spinner)
  71. for i := range modelfile.Commands {
  72. switch modelfile.Commands[i].Name {
  73. case "model", "adapter":
  74. path := modelfile.Commands[i].Args
  75. if path == "~" {
  76. path = home
  77. } else if strings.HasPrefix(path, "~/") {
  78. path = filepath.Join(home, path[2:])
  79. }
  80. if !filepath.IsAbs(path) {
  81. path = filepath.Join(filepath.Dir(filename), path)
  82. }
  83. fi, err := os.Stat(path)
  84. if errors.Is(err, os.ErrNotExist) && modelfile.Commands[i].Name == "model" {
  85. continue
  86. } else if err != nil {
  87. return err
  88. }
  89. if fi.IsDir() {
  90. // this is likely a safetensors or pytorch directory
  91. // TODO make this work w/ adapters
  92. tempfile, err := tempZipFiles(path)
  93. if err != nil {
  94. return err
  95. }
  96. defer os.RemoveAll(tempfile)
  97. path = tempfile
  98. }
  99. digest, err := createBlob(cmd, client, path)
  100. if err != nil {
  101. return err
  102. }
  103. modelfile.Commands[i].Args = "@" + digest
  104. }
  105. }
  106. bars := make(map[string]*progress.Bar)
  107. fn := func(resp api.ProgressResponse) error {
  108. if resp.Digest != "" {
  109. spinner.Stop()
  110. bar, ok := bars[resp.Digest]
  111. if !ok {
  112. bar = progress.NewBar(fmt.Sprintf("pulling %s...", resp.Digest[7:19]), resp.Total, resp.Completed)
  113. bars[resp.Digest] = bar
  114. p.Add(resp.Digest, bar)
  115. }
  116. bar.Set(resp.Completed)
  117. } else if status != resp.Status {
  118. spinner.Stop()
  119. status = resp.Status
  120. spinner = progress.NewSpinner(status)
  121. p.Add(status, spinner)
  122. }
  123. return nil
  124. }
  125. quantize, _ := cmd.Flags().GetString("quantize")
  126. request := api.CreateRequest{Name: args[0], Modelfile: modelfile.String(), Quantize: quantize}
  127. if err := client.Create(cmd.Context(), &request, fn); err != nil {
  128. return err
  129. }
  130. return nil
  131. }
  132. func tempZipFiles(path string) (string, error) {
  133. tempfile, err := os.CreateTemp("", "ollama-tf")
  134. if err != nil {
  135. return "", err
  136. }
  137. defer tempfile.Close()
  138. zipfile := zip.NewWriter(tempfile)
  139. defer zipfile.Close()
  140. detectContentType := func(path string) (string, error) {
  141. f, err := os.Open(path)
  142. if err != nil {
  143. return "", err
  144. }
  145. defer f.Close()
  146. var b bytes.Buffer
  147. b.Grow(512)
  148. if _, err := io.CopyN(&b, f, 512); err != nil && !errors.Is(err, io.EOF) {
  149. return "", err
  150. }
  151. contentType, _, _ := strings.Cut(http.DetectContentType(b.Bytes()), ";")
  152. return contentType, nil
  153. }
  154. glob := func(pattern, contentType string) ([]string, error) {
  155. matches, err := filepath.Glob(pattern)
  156. if err != nil {
  157. return nil, err
  158. }
  159. for _, safetensor := range matches {
  160. if ct, err := detectContentType(safetensor); err != nil {
  161. return nil, err
  162. } else if ct != contentType {
  163. return nil, fmt.Errorf("invalid content type: expected %s for %s", ct, safetensor)
  164. }
  165. }
  166. return matches, nil
  167. }
  168. var files []string
  169. if st, _ := glob(filepath.Join(path, "model*.safetensors"), "application/octet-stream"); len(st) > 0 {
  170. // safetensors files might be unresolved git lfs references; skip if they are
  171. // covers model-x-of-y.safetensors, model.fp32-x-of-y.safetensors, model.safetensors
  172. files = append(files, st...)
  173. } else if pt, _ := glob(filepath.Join(path, "pytorch_model*.bin"), "application/zip"); len(pt) > 0 {
  174. // pytorch files might also be unresolved git lfs references; skip if they are
  175. // covers pytorch_model-x-of-y.bin, pytorch_model.fp32-x-of-y.bin, pytorch_model.bin
  176. files = append(files, pt...)
  177. } else if pt, _ := glob(filepath.Join(path, "consolidated*.pth"), "application/zip"); len(pt) > 0 {
  178. // pytorch files might also be unresolved git lfs references; skip if they are
  179. // covers consolidated.x.pth, consolidated.pth
  180. files = append(files, pt...)
  181. } else {
  182. return "", errors.New("no safetensors or torch files found")
  183. }
  184. // add configuration files, json files are detected as text/plain
  185. js, err := glob(filepath.Join(path, "*.json"), "text/plain")
  186. if err != nil {
  187. return "", err
  188. }
  189. files = append(files, js...)
  190. if tks, _ := glob(filepath.Join(path, "tokenizer.model"), "application/octet-stream"); len(tks) > 0 {
  191. // add tokenizer.model if it exists, tokenizer.json is automatically picked up by the previous glob
  192. // tokenizer.model might be a unresolved git lfs reference; error if it is
  193. files = append(files, tks...)
  194. } else if tks, _ := glob(filepath.Join(path, "**/tokenizer.model"), "text/plain"); len(tks) > 0 {
  195. // some times tokenizer.model is in a subdirectory (e.g. meta-llama/Meta-Llama-3-8B)
  196. files = append(files, tks...)
  197. }
  198. for _, file := range files {
  199. f, err := os.Open(file)
  200. if err != nil {
  201. return "", err
  202. }
  203. defer f.Close()
  204. fi, err := f.Stat()
  205. if err != nil {
  206. return "", err
  207. }
  208. zfi, err := zip.FileInfoHeader(fi)
  209. if err != nil {
  210. return "", err
  211. }
  212. zf, err := zipfile.CreateHeader(zfi)
  213. if err != nil {
  214. return "", err
  215. }
  216. if _, err := io.Copy(zf, f); err != nil {
  217. return "", err
  218. }
  219. }
  220. return tempfile.Name(), nil
  221. }
  222. func createBlob(cmd *cobra.Command, client *api.Client, path string) (string, error) {
  223. bin, err := os.Open(path)
  224. if err != nil {
  225. return "", err
  226. }
  227. defer bin.Close()
  228. hash := sha256.New()
  229. if _, err := io.Copy(hash, bin); err != nil {
  230. return "", err
  231. }
  232. if _, err := bin.Seek(0, io.SeekStart); err != nil {
  233. return "", err
  234. }
  235. digest := fmt.Sprintf("sha256:%x", hash.Sum(nil))
  236. if err = client.CreateBlob(cmd.Context(), digest, bin); err != nil {
  237. return "", err
  238. }
  239. return digest, nil
  240. }
  241. func RunHandler(cmd *cobra.Command, args []string) error {
  242. client, err := api.ClientFromEnvironment()
  243. if err != nil {
  244. return err
  245. }
  246. name := args[0]
  247. // check if the model exists on the server
  248. show, err := client.Show(cmd.Context(), &api.ShowRequest{Name: name})
  249. var statusError api.StatusError
  250. switch {
  251. case errors.As(err, &statusError) && statusError.StatusCode == http.StatusNotFound:
  252. if err := PullHandler(cmd, []string{name}); err != nil {
  253. return err
  254. }
  255. show, err = client.Show(cmd.Context(), &api.ShowRequest{Name: name})
  256. if err != nil {
  257. return err
  258. }
  259. case err != nil:
  260. return err
  261. }
  262. interactive := true
  263. opts := runOptions{
  264. Model: args[0],
  265. WordWrap: os.Getenv("TERM") == "xterm-256color",
  266. Options: map[string]interface{}{},
  267. MultiModal: slices.Contains(show.Details.Families, "clip"),
  268. ParentModel: show.Details.ParentModel,
  269. }
  270. format, err := cmd.Flags().GetString("format")
  271. if err != nil {
  272. return err
  273. }
  274. opts.Format = format
  275. keepAlive, err := cmd.Flags().GetString("keepalive")
  276. if err != nil {
  277. return err
  278. }
  279. if keepAlive != "" {
  280. d, err := time.ParseDuration(keepAlive)
  281. if err != nil {
  282. return err
  283. }
  284. opts.KeepAlive = &api.Duration{Duration: d}
  285. }
  286. prompts := args[1:]
  287. // prepend stdin to the prompt if provided
  288. if !term.IsTerminal(int(os.Stdin.Fd())) {
  289. in, err := io.ReadAll(os.Stdin)
  290. if err != nil {
  291. return err
  292. }
  293. prompts = append([]string{string(in)}, prompts...)
  294. opts.WordWrap = false
  295. interactive = false
  296. }
  297. opts.Prompt = strings.Join(prompts, " ")
  298. if len(prompts) > 0 {
  299. interactive = false
  300. }
  301. nowrap, err := cmd.Flags().GetBool("nowordwrap")
  302. if err != nil {
  303. return err
  304. }
  305. opts.WordWrap = !nowrap
  306. if !interactive {
  307. return generate(cmd, opts)
  308. }
  309. return generateInteractive(cmd, opts)
  310. }
  311. func errFromUnknownKey(unknownKeyErr error) error {
  312. // find SSH public key in the error message
  313. sshKeyPattern := `ssh-\w+ [^\s"]+`
  314. re := regexp.MustCompile(sshKeyPattern)
  315. matches := re.FindStringSubmatch(unknownKeyErr.Error())
  316. if len(matches) > 0 {
  317. serverPubKey := matches[0]
  318. localPubKey, err := auth.GetPublicKey()
  319. if err != nil {
  320. return unknownKeyErr
  321. }
  322. if runtime.GOOS == "linux" && serverPubKey != localPubKey {
  323. // try the ollama service public key
  324. svcPubKey, err := os.ReadFile("/usr/share/ollama/.ollama/id_ed25519.pub")
  325. if err != nil {
  326. return unknownKeyErr
  327. }
  328. localPubKey = strings.TrimSpace(string(svcPubKey))
  329. }
  330. // check if the returned public key matches the local public key, this prevents adding a remote key to the user's account
  331. if serverPubKey != localPubKey {
  332. return unknownKeyErr
  333. }
  334. var msg strings.Builder
  335. msg.WriteString(unknownKeyErr.Error())
  336. msg.WriteString("\n\nYour ollama key is:\n")
  337. msg.WriteString(localPubKey)
  338. msg.WriteString("\nAdd your key at:\n")
  339. msg.WriteString("https://ollama.com/settings/keys")
  340. return errors.New(msg.String())
  341. }
  342. return unknownKeyErr
  343. }
  344. func PushHandler(cmd *cobra.Command, args []string) error {
  345. client, err := api.ClientFromEnvironment()
  346. if err != nil {
  347. return err
  348. }
  349. insecure, err := cmd.Flags().GetBool("insecure")
  350. if err != nil {
  351. return err
  352. }
  353. p := progress.NewProgress(os.Stderr)
  354. defer p.Stop()
  355. bars := make(map[string]*progress.Bar)
  356. var status string
  357. var spinner *progress.Spinner
  358. fn := func(resp api.ProgressResponse) error {
  359. if resp.Digest != "" {
  360. if spinner != nil {
  361. spinner.Stop()
  362. }
  363. bar, ok := bars[resp.Digest]
  364. if !ok {
  365. bar = progress.NewBar(fmt.Sprintf("pushing %s...", resp.Digest[7:19]), resp.Total, resp.Completed)
  366. bars[resp.Digest] = bar
  367. p.Add(resp.Digest, bar)
  368. }
  369. bar.Set(resp.Completed)
  370. } else if status != resp.Status {
  371. if spinner != nil {
  372. spinner.Stop()
  373. }
  374. status = resp.Status
  375. spinner = progress.NewSpinner(status)
  376. p.Add(status, spinner)
  377. }
  378. return nil
  379. }
  380. request := api.PushRequest{Name: args[0], Insecure: insecure}
  381. if err := client.Push(cmd.Context(), &request, fn); err != nil {
  382. if spinner != nil {
  383. spinner.Stop()
  384. }
  385. if strings.Contains(err.Error(), "access denied") {
  386. return errors.New("you are not authorized to push to this namespace, create the model under a namespace you own")
  387. }
  388. host := model.ParseName(args[0]).Host
  389. isOllamaHost := strings.HasSuffix(host, ".ollama.ai") || strings.HasSuffix(host, ".ollama.com")
  390. if strings.Contains(err.Error(), errtypes.UnknownOllamaKeyErrMsg) && isOllamaHost {
  391. // the user has not added their ollama key to ollama.com
  392. // re-throw an error with a more user-friendly message
  393. return errFromUnknownKey(err)
  394. }
  395. return err
  396. }
  397. spinner.Stop()
  398. return nil
  399. }
  400. func ListHandler(cmd *cobra.Command, args []string) error {
  401. client, err := api.ClientFromEnvironment()
  402. if err != nil {
  403. return err
  404. }
  405. models, err := client.List(cmd.Context())
  406. if err != nil {
  407. return err
  408. }
  409. var data [][]string
  410. for _, m := range models.Models {
  411. if len(args) == 0 || strings.HasPrefix(m.Name, args[0]) {
  412. data = append(data, []string{m.Name, m.Digest[:12], format.HumanBytes(m.Size), format.HumanTime(m.ModifiedAt, "Never")})
  413. }
  414. }
  415. table := tablewriter.NewWriter(os.Stdout)
  416. table.SetHeader([]string{"NAME", "ID", "SIZE", "MODIFIED"})
  417. table.SetHeaderAlignment(tablewriter.ALIGN_LEFT)
  418. table.SetAlignment(tablewriter.ALIGN_LEFT)
  419. table.SetHeaderLine(false)
  420. table.SetBorder(false)
  421. table.SetNoWhiteSpace(true)
  422. table.SetTablePadding("\t")
  423. table.AppendBulk(data)
  424. table.Render()
  425. return nil
  426. }
  427. func ListRunningHandler(cmd *cobra.Command, args []string) error {
  428. client, err := api.ClientFromEnvironment()
  429. if err != nil {
  430. return err
  431. }
  432. models, err := client.ListRunning(cmd.Context())
  433. if err != nil {
  434. return err
  435. }
  436. var data [][]string
  437. for _, m := range models.Models {
  438. if len(args) == 0 || strings.HasPrefix(m.Name, args[0]) {
  439. var procStr string
  440. switch {
  441. case m.SizeVRAM == 0:
  442. procStr = "100% CPU"
  443. case m.SizeVRAM == m.Size:
  444. procStr = "100% GPU"
  445. case m.SizeVRAM > m.Size || m.Size == 0:
  446. procStr = "Unknown"
  447. default:
  448. sizeCPU := m.Size - m.SizeVRAM
  449. cpuPercent := math.Round(float64(sizeCPU) / float64(m.Size) * 100)
  450. procStr = fmt.Sprintf("%d%%/%d%% CPU/GPU", int(cpuPercent), int(100-cpuPercent))
  451. }
  452. data = append(data, []string{m.Name, m.Digest[:12], format.HumanBytes(m.Size), procStr, format.HumanTime(m.ExpiresAt, "Never")})
  453. }
  454. }
  455. table := tablewriter.NewWriter(os.Stdout)
  456. table.SetHeader([]string{"NAME", "ID", "SIZE", "PROCESSOR", "UNTIL"})
  457. table.SetHeaderAlignment(tablewriter.ALIGN_LEFT)
  458. table.SetAlignment(tablewriter.ALIGN_LEFT)
  459. table.SetHeaderLine(false)
  460. table.SetBorder(false)
  461. table.SetNoWhiteSpace(true)
  462. table.SetTablePadding("\t")
  463. table.AppendBulk(data)
  464. table.Render()
  465. return nil
  466. }
  467. func DeleteHandler(cmd *cobra.Command, args []string) error {
  468. client, err := api.ClientFromEnvironment()
  469. if err != nil {
  470. return err
  471. }
  472. for _, name := range args {
  473. req := api.DeleteRequest{Name: name}
  474. if err := client.Delete(cmd.Context(), &req); err != nil {
  475. return err
  476. }
  477. fmt.Printf("deleted '%s'\n", name)
  478. }
  479. return nil
  480. }
  481. func ShowHandler(cmd *cobra.Command, args []string) error {
  482. client, err := api.ClientFromEnvironment()
  483. if err != nil {
  484. return err
  485. }
  486. if len(args) == 0 {
  487. return errors.New("missing model name")
  488. } else if len(args) > 1 {
  489. return errors.New("only one model name can be specified")
  490. }
  491. model, errModel := cmd.Flags().GetBool("model")
  492. license, errLicense := cmd.Flags().GetBool("license")
  493. modelfile, errModelfile := cmd.Flags().GetBool("modelfile")
  494. parameters, errParams := cmd.Flags().GetBool("parameters")
  495. system, errSystem := cmd.Flags().GetBool("system")
  496. template, errTemplate := cmd.Flags().GetBool("template")
  497. for _, boolErr := range []error{errModel, errLicense, errModelfile, errParams, errSystem, errTemplate} {
  498. if boolErr != nil {
  499. return errors.New("error retrieving flags")
  500. }
  501. }
  502. flagsSet := 0
  503. showType := ""
  504. if model {
  505. flagsSet++
  506. showType = "model"
  507. }
  508. if license {
  509. flagsSet++
  510. showType = "license"
  511. }
  512. if modelfile {
  513. flagsSet++
  514. showType = "modelfile"
  515. }
  516. if parameters {
  517. flagsSet++
  518. showType = "parameters"
  519. }
  520. if system {
  521. flagsSet++
  522. showType = "system"
  523. }
  524. if template {
  525. flagsSet++
  526. showType = "template"
  527. }
  528. switch flagsSet {
  529. case 0:
  530. req := api.ShowRequest{Name: args[0]}
  531. resp, err := client.Show(cmd.Context(), &req)
  532. if err != nil {
  533. return err
  534. }
  535. var data []string
  536. data = append(data,
  537. strings.Join([]string{
  538. fmt.Sprintf("arch %v", resp.ModelInfo["general.architecture"]),
  539. fmt.Sprintf("parameters %v", resp.Details.ParameterSize),
  540. fmt.Sprintf("quantization %v", resp.Details.QuantizationLevel),
  541. }, " · "),
  542. truncate(resp.License),
  543. truncate(resp.Modelfile),
  544. handleParams(resp.Parameters),
  545. truncate(resp.System),
  546. truncate(resp.Template),
  547. )
  548. headers := []string{
  549. "MODEL",
  550. "LICENSE",
  551. "MODELFILE",
  552. "PARAMETERS",
  553. "SYSTEM",
  554. "TEMPLATE",
  555. }
  556. table := tablewriter.NewWriter(os.Stdout)
  557. table.SetHeaderAlignment(tablewriter.ALIGN_LEFT)
  558. table.SetAlignment(tablewriter.ALIGN_LEFT)
  559. table.SetBorder(false)
  560. table.SetNoWhiteSpace(true)
  561. table.SetTablePadding("\t")
  562. table.SetAutoWrapText(false)
  563. for i := 0; i < len(headers); i++ {
  564. if data[i] != "" {
  565. table.Append([]string{headers[i], data[i]})
  566. }
  567. }
  568. table.Render()
  569. case 1:
  570. req := api.ShowRequest{Name: args[0]}
  571. resp, err := client.Show(cmd.Context(), &req)
  572. if err != nil {
  573. return err
  574. }
  575. switch showType {
  576. case "license":
  577. fmt.Println(resp.License)
  578. case "modelfile":
  579. fmt.Println(resp.Modelfile)
  580. case "parameters":
  581. fmt.Println(resp.Parameters)
  582. case "system":
  583. fmt.Println(resp.System)
  584. case "template":
  585. fmt.Println(resp.Template)
  586. case "model":
  587. fmt.Println(
  588. strings.Join([]string{
  589. fmt.Sprintf("arch %v", resp.ModelInfo["general.architecture"]),
  590. fmt.Sprintf("parameters %v", resp.Details.ParameterSize),
  591. fmt.Sprintf("quantization %v", resp.Details.QuantizationLevel),
  592. }, " · "),
  593. )
  594. }
  595. default:
  596. return errors.New("only one of '--model', --license', '--modelfile', '--parameters', '--system', or '--template' can be specified")
  597. }
  598. return nil
  599. }
  600. func truncate(s string) string {
  601. lines := strings.Split(s, "\n")
  602. var truncated strings.Builder
  603. for _, line := range lines {
  604. line = strings.TrimSpace(line)
  605. if line != "" {
  606. truncated.WriteString(line + " ")
  607. if truncated.Len() > 60 {
  608. return truncated.String()[:57] + "..."
  609. }
  610. }
  611. }
  612. return strings.TrimSpace(truncated.String())
  613. }
  614. // temporary fix for buggy params #4918
  615. func handleParams(s string) string {
  616. lines := strings.Split(s, "\n")
  617. var truncated strings.Builder
  618. truncated.WriteString("{")
  619. for _, line := range lines {
  620. line = strings.Join(strings.Fields(line), ":")
  621. truncated.WriteString(line + ",")
  622. if truncated.Len() > 60 {
  623. return truncated.String()[:57] + "..."
  624. }
  625. }
  626. return strings.TrimSpace(truncated.String()) + "}"
  627. }
  628. func CopyHandler(cmd *cobra.Command, args []string) error {
  629. client, err := api.ClientFromEnvironment()
  630. if err != nil {
  631. return err
  632. }
  633. req := api.CopyRequest{Source: args[0], Destination: args[1]}
  634. if err := client.Copy(cmd.Context(), &req); err != nil {
  635. return err
  636. }
  637. fmt.Printf("copied '%s' to '%s'\n", args[0], args[1])
  638. return nil
  639. }
  640. func PullHandler(cmd *cobra.Command, args []string) error {
  641. insecure, err := cmd.Flags().GetBool("insecure")
  642. if err != nil {
  643. return err
  644. }
  645. client, err := api.ClientFromEnvironment()
  646. if err != nil {
  647. return err
  648. }
  649. p := progress.NewProgress(os.Stderr)
  650. defer p.Stop()
  651. bars := make(map[string]*progress.Bar)
  652. var status string
  653. var spinner *progress.Spinner
  654. fn := func(resp api.ProgressResponse) error {
  655. if resp.Digest != "" {
  656. if spinner != nil {
  657. spinner.Stop()
  658. }
  659. bar, ok := bars[resp.Digest]
  660. if !ok {
  661. bar = progress.NewBar(fmt.Sprintf("pulling %s...", resp.Digest[7:19]), resp.Total, resp.Completed)
  662. bars[resp.Digest] = bar
  663. p.Add(resp.Digest, bar)
  664. }
  665. bar.Set(resp.Completed)
  666. } else if status != resp.Status {
  667. if spinner != nil {
  668. spinner.Stop()
  669. }
  670. status = resp.Status
  671. spinner = progress.NewSpinner(status)
  672. p.Add(status, spinner)
  673. }
  674. return nil
  675. }
  676. request := api.PullRequest{Name: args[0], Insecure: insecure}
  677. if err := client.Pull(cmd.Context(), &request, fn); err != nil {
  678. return err
  679. }
  680. return nil
  681. }
  682. type generateContextKey string
  683. type runOptions struct {
  684. Model string
  685. ParentModel string
  686. Prompt string
  687. Messages []api.Message
  688. WordWrap bool
  689. Format string
  690. System string
  691. Template string
  692. Images []api.ImageData
  693. Options map[string]interface{}
  694. MultiModal bool
  695. KeepAlive *api.Duration
  696. }
  697. type displayResponseState struct {
  698. lineLength int
  699. wordBuffer string
  700. }
  701. func displayResponse(content string, wordWrap bool, state *displayResponseState) {
  702. termWidth, _, _ := term.GetSize(int(os.Stdout.Fd()))
  703. if wordWrap && termWidth >= 10 {
  704. for _, ch := range content {
  705. if state.lineLength+1 > termWidth-5 {
  706. if runewidth.StringWidth(state.wordBuffer) > termWidth-10 {
  707. fmt.Printf("%s%c", state.wordBuffer, ch)
  708. state.wordBuffer = ""
  709. state.lineLength = 0
  710. continue
  711. }
  712. // backtrack the length of the last word and clear to the end of the line
  713. a := runewidth.StringWidth(state.wordBuffer)
  714. if a > 0 {
  715. fmt.Printf("\x1b[%dD", a)
  716. }
  717. fmt.Printf("\x1b[K\n")
  718. fmt.Printf("%s%c", state.wordBuffer, ch)
  719. chWidth := runewidth.RuneWidth(ch)
  720. state.lineLength = runewidth.StringWidth(state.wordBuffer) + chWidth
  721. } else {
  722. fmt.Print(string(ch))
  723. state.lineLength += runewidth.RuneWidth(ch)
  724. if runewidth.RuneWidth(ch) >= 2 {
  725. state.wordBuffer = ""
  726. continue
  727. }
  728. switch ch {
  729. case ' ':
  730. state.wordBuffer = ""
  731. case '\n':
  732. state.lineLength = 0
  733. default:
  734. state.wordBuffer += string(ch)
  735. }
  736. }
  737. }
  738. } else {
  739. fmt.Printf("%s%s", state.wordBuffer, content)
  740. if len(state.wordBuffer) > 0 {
  741. state.wordBuffer = ""
  742. }
  743. }
  744. }
  745. func chat(cmd *cobra.Command, opts runOptions) (*api.Message, error) {
  746. client, err := api.ClientFromEnvironment()
  747. if err != nil {
  748. return nil, err
  749. }
  750. p := progress.NewProgress(os.Stderr)
  751. defer p.StopAndClear()
  752. spinner := progress.NewSpinner("")
  753. p.Add("", spinner)
  754. cancelCtx, cancel := context.WithCancel(cmd.Context())
  755. defer cancel()
  756. sigChan := make(chan os.Signal, 1)
  757. signal.Notify(sigChan, syscall.SIGINT)
  758. go func() {
  759. <-sigChan
  760. cancel()
  761. }()
  762. var state *displayResponseState = &displayResponseState{}
  763. var latest api.ChatResponse
  764. var fullResponse strings.Builder
  765. var role string
  766. fn := func(response api.ChatResponse) error {
  767. p.StopAndClear()
  768. latest = response
  769. role = response.Message.Role
  770. content := response.Message.Content
  771. fullResponse.WriteString(content)
  772. displayResponse(content, opts.WordWrap, state)
  773. return nil
  774. }
  775. req := &api.ChatRequest{
  776. Model: opts.Model,
  777. Messages: opts.Messages,
  778. Format: opts.Format,
  779. Options: opts.Options,
  780. }
  781. if opts.KeepAlive != nil {
  782. req.KeepAlive = opts.KeepAlive
  783. }
  784. if err := client.Chat(cancelCtx, req, fn); err != nil {
  785. if errors.Is(err, context.Canceled) {
  786. return nil, nil
  787. }
  788. return nil, err
  789. }
  790. if len(opts.Messages) > 0 {
  791. fmt.Println()
  792. fmt.Println()
  793. }
  794. verbose, err := cmd.Flags().GetBool("verbose")
  795. if err != nil {
  796. return nil, err
  797. }
  798. if verbose {
  799. latest.Summary()
  800. }
  801. return &api.Message{Role: role, Content: fullResponse.String()}, nil
  802. }
  803. func generate(cmd *cobra.Command, opts runOptions) error {
  804. client, err := api.ClientFromEnvironment()
  805. if err != nil {
  806. return err
  807. }
  808. p := progress.NewProgress(os.Stderr)
  809. defer p.StopAndClear()
  810. spinner := progress.NewSpinner("")
  811. p.Add("", spinner)
  812. var latest api.GenerateResponse
  813. generateContext, ok := cmd.Context().Value(generateContextKey("context")).([]int)
  814. if !ok {
  815. generateContext = []int{}
  816. }
  817. ctx, cancel := context.WithCancel(cmd.Context())
  818. defer cancel()
  819. sigChan := make(chan os.Signal, 1)
  820. signal.Notify(sigChan, syscall.SIGINT)
  821. go func() {
  822. <-sigChan
  823. cancel()
  824. }()
  825. var state *displayResponseState = &displayResponseState{}
  826. fn := func(response api.GenerateResponse) error {
  827. p.StopAndClear()
  828. latest = response
  829. content := response.Response
  830. displayResponse(content, opts.WordWrap, state)
  831. return nil
  832. }
  833. if opts.MultiModal {
  834. opts.Prompt, opts.Images, err = extractFileData(opts.Prompt)
  835. if err != nil {
  836. return err
  837. }
  838. }
  839. request := api.GenerateRequest{
  840. Model: opts.Model,
  841. Prompt: opts.Prompt,
  842. Context: generateContext,
  843. Images: opts.Images,
  844. Format: opts.Format,
  845. System: opts.System,
  846. Template: opts.Template,
  847. Options: opts.Options,
  848. KeepAlive: opts.KeepAlive,
  849. }
  850. if err := client.Generate(ctx, &request, fn); err != nil {
  851. if errors.Is(err, context.Canceled) {
  852. return nil
  853. }
  854. return err
  855. }
  856. if opts.Prompt != "" {
  857. fmt.Println()
  858. fmt.Println()
  859. }
  860. if !latest.Done {
  861. return nil
  862. }
  863. verbose, err := cmd.Flags().GetBool("verbose")
  864. if err != nil {
  865. return err
  866. }
  867. if verbose {
  868. latest.Summary()
  869. }
  870. ctx = context.WithValue(cmd.Context(), generateContextKey("context"), latest.Context)
  871. cmd.SetContext(ctx)
  872. return nil
  873. }
  874. func RunServer(cmd *cobra.Command, _ []string) error {
  875. // retrieve the OLLAMA_HOST environment variable
  876. ollamaHost, err := api.GetOllamaHost()
  877. if err != nil {
  878. return err
  879. }
  880. if err := initializeKeypair(); err != nil {
  881. return err
  882. }
  883. ln, err := net.Listen("tcp", net.JoinHostPort(ollamaHost.Host, ollamaHost.Port))
  884. if err != nil {
  885. return err
  886. }
  887. err = server.Serve(ln)
  888. if errors.Is(err, http.ErrServerClosed) {
  889. return nil
  890. }
  891. return err
  892. }
  893. func initializeKeypair() error {
  894. home, err := os.UserHomeDir()
  895. if err != nil {
  896. return err
  897. }
  898. privKeyPath := filepath.Join(home, ".ollama", "id_ed25519")
  899. pubKeyPath := filepath.Join(home, ".ollama", "id_ed25519.pub")
  900. _, err = os.Stat(privKeyPath)
  901. if os.IsNotExist(err) {
  902. fmt.Printf("Couldn't find '%s'. Generating new private key.\n", privKeyPath)
  903. cryptoPublicKey, cryptoPrivateKey, err := ed25519.GenerateKey(rand.Reader)
  904. if err != nil {
  905. return err
  906. }
  907. privateKeyBytes, err := ssh.MarshalPrivateKey(cryptoPrivateKey, "")
  908. if err != nil {
  909. return err
  910. }
  911. if err := os.MkdirAll(filepath.Dir(privKeyPath), 0o755); err != nil {
  912. return fmt.Errorf("could not create directory %w", err)
  913. }
  914. if err := os.WriteFile(privKeyPath, pem.EncodeToMemory(privateKeyBytes), 0o600); err != nil {
  915. return err
  916. }
  917. sshPublicKey, err := ssh.NewPublicKey(cryptoPublicKey)
  918. if err != nil {
  919. return err
  920. }
  921. publicKeyBytes := ssh.MarshalAuthorizedKey(sshPublicKey)
  922. if err := os.WriteFile(pubKeyPath, publicKeyBytes, 0o644); err != nil {
  923. return err
  924. }
  925. fmt.Printf("Your new public key is: \n\n%s\n", publicKeyBytes)
  926. }
  927. return nil
  928. }
  929. func checkServerHeartbeat(cmd *cobra.Command, _ []string) error {
  930. client, err := api.ClientFromEnvironment()
  931. if err != nil {
  932. return err
  933. }
  934. if err := client.Heartbeat(cmd.Context()); err != nil {
  935. if !strings.Contains(err.Error(), " refused") {
  936. return err
  937. }
  938. if err := startApp(cmd.Context(), client); err != nil {
  939. return fmt.Errorf("could not connect to ollama app, is it running?")
  940. }
  941. }
  942. return nil
  943. }
  944. func versionHandler(cmd *cobra.Command, _ []string) {
  945. client, err := api.ClientFromEnvironment()
  946. if err != nil {
  947. return
  948. }
  949. serverVersion, err := client.Version(cmd.Context())
  950. if err != nil {
  951. fmt.Println("Warning: could not connect to a running Ollama instance")
  952. }
  953. if serverVersion != "" {
  954. fmt.Printf("ollama version is %s\n", serverVersion)
  955. }
  956. if serverVersion != version.Version {
  957. fmt.Printf("Warning: client version is %s\n", version.Version)
  958. }
  959. }
  960. func appendEnvDocs(cmd *cobra.Command, envs []envconfig.EnvVar) {
  961. if len(envs) == 0 {
  962. return
  963. }
  964. envUsage := `
  965. Environment Variables:
  966. `
  967. for _, e := range envs {
  968. envUsage += fmt.Sprintf(" %-24s %s\n", e.Name, e.Description)
  969. }
  970. cmd.SetUsageTemplate(cmd.UsageTemplate() + envUsage)
  971. }
  972. func NewCLI() *cobra.Command {
  973. log.SetFlags(log.LstdFlags | log.Lshortfile)
  974. cobra.EnableCommandSorting = false
  975. if runtime.GOOS == "windows" {
  976. console.ConsoleFromFile(os.Stdin) //nolint:errcheck
  977. }
  978. rootCmd := &cobra.Command{
  979. Use: "ollama",
  980. Short: "Large language model runner",
  981. SilenceUsage: true,
  982. SilenceErrors: true,
  983. CompletionOptions: cobra.CompletionOptions{
  984. DisableDefaultCmd: true,
  985. },
  986. Run: func(cmd *cobra.Command, args []string) {
  987. if version, _ := cmd.Flags().GetBool("version"); version {
  988. versionHandler(cmd, args)
  989. return
  990. }
  991. cmd.Print(cmd.UsageString())
  992. },
  993. }
  994. rootCmd.Flags().BoolP("version", "v", false, "Show version information")
  995. createCmd := &cobra.Command{
  996. Use: "create MODEL",
  997. Short: "Create a model from a Modelfile",
  998. Args: cobra.ExactArgs(1),
  999. PreRunE: checkServerHeartbeat,
  1000. RunE: CreateHandler,
  1001. }
  1002. createCmd.Flags().StringP("file", "f", "Modelfile", "Name of the Modelfile")
  1003. createCmd.Flags().StringP("quantize", "q", "", "Quantize model to this level (e.g. q4_0)")
  1004. showCmd := &cobra.Command{
  1005. Use: "show MODEL",
  1006. Short: "Show information for a model",
  1007. PreRunE: checkServerHeartbeat,
  1008. RunE: ShowHandler,
  1009. }
  1010. showCmd.Flags().Bool("model", false, "Show basic stats of a model")
  1011. showCmd.Flags().Bool("license", false, "Show license of a model")
  1012. showCmd.Flags().Bool("modelfile", false, "Show Modelfile of a model")
  1013. showCmd.Flags().Bool("parameters", false, "Show parameters of a model")
  1014. showCmd.Flags().Bool("template", false, "Show template of a model")
  1015. showCmd.Flags().Bool("system", false, "Show system message of a model")
  1016. runCmd := &cobra.Command{
  1017. Use: "run MODEL [PROMPT]",
  1018. Short: "Run a model",
  1019. Args: cobra.MinimumNArgs(1),
  1020. PreRunE: checkServerHeartbeat,
  1021. RunE: RunHandler,
  1022. }
  1023. runCmd.Flags().String("keepalive", "", "Duration to keep a model loaded (e.g. 5m)")
  1024. runCmd.Flags().Bool("verbose", false, "Show timings for response")
  1025. runCmd.Flags().Bool("insecure", false, "Use an insecure registry")
  1026. runCmd.Flags().Bool("nowordwrap", false, "Don't wrap words to the next line automatically")
  1027. runCmd.Flags().String("format", "", "Response format (e.g. json)")
  1028. serveCmd := &cobra.Command{
  1029. Use: "serve",
  1030. Aliases: []string{"start"},
  1031. Short: "Start ollama",
  1032. Args: cobra.ExactArgs(0),
  1033. RunE: RunServer,
  1034. }
  1035. pullCmd := &cobra.Command{
  1036. Use: "pull MODEL",
  1037. Short: "Pull a model from a registry",
  1038. Args: cobra.ExactArgs(1),
  1039. PreRunE: checkServerHeartbeat,
  1040. RunE: PullHandler,
  1041. }
  1042. pullCmd.Flags().Bool("insecure", false, "Use an insecure registry")
  1043. pushCmd := &cobra.Command{
  1044. Use: "push MODEL",
  1045. Short: "Push a model to a registry",
  1046. Args: cobra.ExactArgs(1),
  1047. PreRunE: checkServerHeartbeat,
  1048. RunE: PushHandler,
  1049. }
  1050. pushCmd.Flags().Bool("insecure", false, "Use an insecure registry")
  1051. listCmd := &cobra.Command{
  1052. Use: "list",
  1053. Aliases: []string{"ls"},
  1054. Short: "List models",
  1055. PreRunE: checkServerHeartbeat,
  1056. RunE: ListHandler,
  1057. }
  1058. psCmd := &cobra.Command{
  1059. Use: "ps",
  1060. Short: "List running models",
  1061. PreRunE: checkServerHeartbeat,
  1062. RunE: ListRunningHandler,
  1063. }
  1064. copyCmd := &cobra.Command{
  1065. Use: "cp SOURCE DESTINATION",
  1066. Short: "Copy a model",
  1067. Args: cobra.ExactArgs(2),
  1068. PreRunE: checkServerHeartbeat,
  1069. RunE: CopyHandler,
  1070. }
  1071. deleteCmd := &cobra.Command{
  1072. Use: "rm MODEL [MODEL...]",
  1073. Short: "Remove a model",
  1074. Args: cobra.MinimumNArgs(1),
  1075. PreRunE: checkServerHeartbeat,
  1076. RunE: DeleteHandler,
  1077. }
  1078. envVars := envconfig.AsMap()
  1079. envs := []envconfig.EnvVar{envVars["OLLAMA_HOST"]}
  1080. for _, cmd := range []*cobra.Command{
  1081. createCmd,
  1082. showCmd,
  1083. runCmd,
  1084. pullCmd,
  1085. pushCmd,
  1086. listCmd,
  1087. psCmd,
  1088. copyCmd,
  1089. deleteCmd,
  1090. serveCmd,
  1091. } {
  1092. switch cmd {
  1093. case runCmd:
  1094. appendEnvDocs(cmd, []envconfig.EnvVar{envVars["OLLAMA_HOST"], envVars["OLLAMA_NOHISTORY"]})
  1095. case serveCmd:
  1096. appendEnvDocs(cmd, []envconfig.EnvVar{
  1097. envVars["OLLAMA_DEBUG"],
  1098. envVars["OLLAMA_HOST"],
  1099. envVars["OLLAMA_KEEP_ALIVE"],
  1100. envVars["OLLAMA_MAX_LOADED_MODELS"],
  1101. envVars["OLLAMA_MAX_QUEUE"],
  1102. envVars["OLLAMA_MODELS"],
  1103. envVars["OLLAMA_NUM_PARALLEL"],
  1104. envVars["OLLAMA_NOPRUNE"],
  1105. envVars["OLLAMA_ORIGINS"],
  1106. envVars["OLLAMA_TMPDIR"],
  1107. envVars["OLLAMA_FLASH_ATTENTION"],
  1108. envVars["OLLAMA_LLM_LIBRARY"],
  1109. envVars["OLLAMA_MAX_VRAM"],
  1110. })
  1111. default:
  1112. appendEnvDocs(cmd, envs)
  1113. }
  1114. }
  1115. rootCmd.AddCommand(
  1116. serveCmd,
  1117. createCmd,
  1118. showCmd,
  1119. runCmd,
  1120. pullCmd,
  1121. pushCmd,
  1122. listCmd,
  1123. psCmd,
  1124. copyCmd,
  1125. deleteCmd,
  1126. )
  1127. return rootCmd
  1128. }