cmd.go 33 KB

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