cmd.go 32 KB

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