cmd.go 32 KB

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