cmd.go 33 KB

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