cmd.go 32 KB

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