cmd.go 33 KB

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