cmd.go 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674
  1. package cmd
  2. import (
  3. "bufio"
  4. "context"
  5. "errors"
  6. "fmt"
  7. "io"
  8. "log"
  9. "net"
  10. "net/http"
  11. "os"
  12. "os/exec"
  13. "path/filepath"
  14. "runtime"
  15. "strings"
  16. "time"
  17. "github.com/chzyer/readline"
  18. "github.com/dustin/go-humanize"
  19. "github.com/olekukonko/tablewriter"
  20. "github.com/spf13/cobra"
  21. "github.com/jmorganca/ollama/api"
  22. "github.com/jmorganca/ollama/format"
  23. "github.com/jmorganca/ollama/progressbar"
  24. "github.com/jmorganca/ollama/server"
  25. )
  26. func CreateHandler(cmd *cobra.Command, args []string) error {
  27. filename, _ := cmd.Flags().GetString("file")
  28. filename, err := filepath.Abs(filename)
  29. if err != nil {
  30. return err
  31. }
  32. client := api.NewClient()
  33. var spinner *Spinner
  34. var currentDigest string
  35. var bar *progressbar.ProgressBar
  36. request := api.CreateRequest{Name: args[0], Path: filename}
  37. fn := func(resp api.ProgressResponse) error {
  38. if resp.Digest != currentDigest && resp.Digest != "" {
  39. if spinner != nil {
  40. spinner.Stop()
  41. }
  42. currentDigest = resp.Digest
  43. bar = progressbar.DefaultBytes(
  44. int64(resp.Total),
  45. fmt.Sprintf("pulling %s...", resp.Digest[7:19]),
  46. )
  47. bar.Set(resp.Completed)
  48. } else if resp.Digest == currentDigest && resp.Digest != "" {
  49. bar.Set(resp.Completed)
  50. } else {
  51. currentDigest = ""
  52. if spinner != nil {
  53. spinner.Stop()
  54. }
  55. spinner = NewSpinner(resp.Status)
  56. go spinner.Spin(100 * time.Millisecond)
  57. }
  58. return nil
  59. }
  60. if err := client.Create(context.Background(), &request, fn); err != nil {
  61. return err
  62. }
  63. if spinner != nil {
  64. spinner.Stop()
  65. }
  66. return nil
  67. }
  68. func RunHandler(cmd *cobra.Command, args []string) error {
  69. mp := server.ParseModelPath(args[0])
  70. fp, err := mp.GetManifestPath(false)
  71. if err != nil {
  72. return err
  73. }
  74. _, err = os.Stat(fp)
  75. switch {
  76. case errors.Is(err, os.ErrNotExist):
  77. if err := pull(args[0], false); err != nil {
  78. var apiStatusError api.StatusError
  79. if !errors.As(err, &apiStatusError) {
  80. return err
  81. }
  82. if apiStatusError.StatusCode != http.StatusBadGateway {
  83. return err
  84. }
  85. }
  86. case err != nil:
  87. return err
  88. }
  89. return RunGenerate(cmd, args)
  90. }
  91. func PushHandler(cmd *cobra.Command, args []string) error {
  92. client := api.NewClient()
  93. insecure, err := cmd.Flags().GetBool("insecure")
  94. if err != nil {
  95. return err
  96. }
  97. var currentDigest string
  98. var bar *progressbar.ProgressBar
  99. request := api.PushRequest{Name: args[0], Insecure: insecure}
  100. fn := func(resp api.ProgressResponse) error {
  101. if resp.Digest != currentDigest && resp.Digest != "" {
  102. currentDigest = resp.Digest
  103. bar = progressbar.DefaultBytes(
  104. int64(resp.Total),
  105. fmt.Sprintf("pushing %s...", resp.Digest[7:19]),
  106. )
  107. bar.Set(resp.Completed)
  108. } else if resp.Digest == currentDigest && resp.Digest != "" {
  109. bar.Set(resp.Completed)
  110. } else {
  111. currentDigest = ""
  112. fmt.Println(resp.Status)
  113. }
  114. return nil
  115. }
  116. if err := client.Push(context.Background(), &request, fn); err != nil {
  117. return err
  118. }
  119. return nil
  120. }
  121. func ListHandler(cmd *cobra.Command, args []string) error {
  122. client := api.NewClient()
  123. models, err := client.List(context.Background())
  124. if err != nil {
  125. return err
  126. }
  127. var data [][]string
  128. for _, m := range models.Models {
  129. if len(args) == 0 || strings.HasPrefix(m.Name, args[0]) {
  130. data = append(data, []string{m.Name, humanize.Bytes(uint64(m.Size)), format.HumanTime(m.ModifiedAt, "Never")})
  131. }
  132. }
  133. table := tablewriter.NewWriter(os.Stdout)
  134. table.SetHeader([]string{"NAME", "SIZE", "MODIFIED"})
  135. table.SetHeaderAlignment(tablewriter.ALIGN_LEFT)
  136. table.SetAlignment(tablewriter.ALIGN_LEFT)
  137. table.SetHeaderLine(false)
  138. table.SetBorder(false)
  139. table.SetNoWhiteSpace(true)
  140. table.SetTablePadding("\t")
  141. table.AppendBulk(data)
  142. table.Render()
  143. return nil
  144. }
  145. func DeleteHandler(cmd *cobra.Command, args []string) error {
  146. client := api.NewClient()
  147. req := api.DeleteRequest{Name: args[0]}
  148. if err := client.Delete(context.Background(), &req); err != nil {
  149. return err
  150. }
  151. fmt.Printf("deleted '%s'\n", args[0])
  152. return nil
  153. }
  154. func CopyHandler(cmd *cobra.Command, args []string) error {
  155. client := api.NewClient()
  156. req := api.CopyRequest{Source: args[0], Destination: args[1]}
  157. if err := client.Copy(context.Background(), &req); err != nil {
  158. return err
  159. }
  160. fmt.Printf("copied '%s' to '%s'\n", args[0], args[1])
  161. return nil
  162. }
  163. func PullHandler(cmd *cobra.Command, args []string) error {
  164. insecure, err := cmd.Flags().GetBool("insecure")
  165. if err != nil {
  166. return err
  167. }
  168. return pull(args[0], insecure)
  169. }
  170. func pull(model string, insecure bool) error {
  171. client := api.NewClient()
  172. var currentDigest string
  173. var bar *progressbar.ProgressBar
  174. request := api.PullRequest{Name: model, Insecure: insecure}
  175. fn := func(resp api.ProgressResponse) error {
  176. if resp.Digest != currentDigest && resp.Digest != "" {
  177. currentDigest = resp.Digest
  178. bar = progressbar.DefaultBytes(
  179. int64(resp.Total),
  180. fmt.Sprintf("pulling %s...", resp.Digest[7:19]),
  181. )
  182. bar.Set(resp.Completed)
  183. } else if resp.Digest == currentDigest && resp.Digest != "" {
  184. bar.Set(resp.Completed)
  185. } else {
  186. currentDigest = ""
  187. fmt.Println(resp.Status)
  188. }
  189. return nil
  190. }
  191. if err := client.Pull(context.Background(), &request, fn); err != nil {
  192. return err
  193. }
  194. return nil
  195. }
  196. func RunGenerate(cmd *cobra.Command, args []string) error {
  197. if len(args) > 1 {
  198. // join all args into a single prompt
  199. return generate(cmd, args[0], strings.Join(args[1:], " "))
  200. }
  201. if readline.IsTerminal(int(os.Stdin.Fd())) {
  202. return generateInteractive(cmd, args[0])
  203. }
  204. return generateBatch(cmd, args[0])
  205. }
  206. type generateContextKey string
  207. func generate(cmd *cobra.Command, model, prompt string) error {
  208. if len(strings.TrimSpace(prompt)) > 0 {
  209. client := api.NewClient()
  210. spinner := NewSpinner("")
  211. go spinner.Spin(60 * time.Millisecond)
  212. var latest api.GenerateResponse
  213. generateContext, ok := cmd.Context().Value(generateContextKey("context")).([]int)
  214. if !ok {
  215. generateContext = []int{}
  216. }
  217. generateSession, ok := cmd.Context().Value(generateContextKey("session")).(int64)
  218. if !ok {
  219. generateSession = 0
  220. }
  221. request := api.GenerateRequest{Model: model, Prompt: prompt, Context: generateContext, SessionID: generateSession}
  222. fn := func(response api.GenerateResponse) error {
  223. if !spinner.IsFinished() {
  224. spinner.Finish()
  225. }
  226. latest = response
  227. fmt.Print(response.Response)
  228. return nil
  229. }
  230. if err := client.Generate(context.Background(), &request, fn); err != nil {
  231. return err
  232. }
  233. fmt.Println()
  234. fmt.Println()
  235. verbose, err := cmd.Flags().GetBool("verbose")
  236. if err != nil {
  237. return err
  238. }
  239. if verbose {
  240. latest.Summary()
  241. }
  242. ctx := cmd.Context()
  243. ctx = context.WithValue(ctx, generateContextKey("context"), latest.Context)
  244. ctx = context.WithValue(ctx, generateContextKey("session"), latest.SessionID)
  245. cmd.SetContext(ctx)
  246. }
  247. return nil
  248. }
  249. func showLayer(l *server.Layer) {
  250. filename, err := server.GetBlobsPath(l.Digest)
  251. bts, err := os.ReadFile(filename)
  252. if err != nil {
  253. fmt.Printf("Couldn't read layer")
  254. return
  255. }
  256. fmt.Printf(string(bts) + "\n")
  257. }
  258. func generateInteractive(cmd *cobra.Command, model string) error {
  259. home, err := os.UserHomeDir()
  260. if err != nil {
  261. return err
  262. }
  263. completer := readline.NewPrefixCompleter(
  264. readline.PcItem("/help"),
  265. readline.PcItem("/list"),
  266. readline.PcItem("/set",
  267. readline.PcItem("history"),
  268. readline.PcItem("nohistory"),
  269. readline.PcItem("verbose"),
  270. readline.PcItem("quiet"),
  271. readline.PcItem("mode",
  272. readline.PcItem("vim"),
  273. readline.PcItem("emacs"),
  274. readline.PcItem("default"),
  275. ),
  276. ),
  277. readline.PcItem("/show",
  278. readline.PcItem("license"),
  279. readline.PcItem("system"),
  280. readline.PcItem("template"),
  281. ),
  282. readline.PcItem("/exit"),
  283. readline.PcItem("/bye"),
  284. )
  285. usage := func() {
  286. fmt.Fprintln(os.Stderr, "commands:")
  287. fmt.Fprintln(os.Stderr, completer.Tree(" "))
  288. }
  289. config := readline.Config{
  290. Prompt: ">>> ",
  291. HistoryFile: filepath.Join(home, ".ollama", "history"),
  292. AutoComplete: completer,
  293. }
  294. scanner, err := readline.NewEx(&config)
  295. if err != nil {
  296. return err
  297. }
  298. defer scanner.Close()
  299. var multiLineBuffer string
  300. var isMultiLine bool
  301. for {
  302. line, err := scanner.Readline()
  303. switch {
  304. case errors.Is(err, io.EOF):
  305. return nil
  306. case errors.Is(err, readline.ErrInterrupt):
  307. if line == "" {
  308. return nil
  309. }
  310. continue
  311. case err != nil:
  312. return err
  313. }
  314. line = strings.TrimSpace(line)
  315. switch {
  316. case isMultiLine:
  317. if strings.HasSuffix(line, `"""`) {
  318. isMultiLine = false
  319. multiLineBuffer += strings.TrimSuffix(line, `"""`)
  320. line = multiLineBuffer
  321. multiLineBuffer = ""
  322. scanner.SetPrompt(">>> ")
  323. } else {
  324. multiLineBuffer += line + " "
  325. continue
  326. }
  327. case strings.HasPrefix(line, `"""`):
  328. isMultiLine = true
  329. multiLineBuffer = strings.TrimPrefix(line, `"""`) + " "
  330. scanner.SetPrompt("... ")
  331. continue
  332. case strings.HasPrefix(line, "/list"):
  333. args := strings.Fields(line)
  334. if err := ListHandler(cmd, args[1:]); err != nil {
  335. return err
  336. }
  337. continue
  338. case strings.HasPrefix(line, "/set"):
  339. args := strings.Fields(line)
  340. if len(args) > 1 {
  341. switch args[1] {
  342. case "history":
  343. scanner.HistoryEnable()
  344. continue
  345. case "nohistory":
  346. scanner.HistoryDisable()
  347. continue
  348. case "verbose":
  349. cmd.Flags().Set("verbose", "true")
  350. continue
  351. case "quiet":
  352. cmd.Flags().Set("verbose", "false")
  353. continue
  354. case "mode":
  355. if len(args) > 2 {
  356. switch args[2] {
  357. case "vim":
  358. scanner.SetVimMode(true)
  359. continue
  360. case "emacs", "default":
  361. scanner.SetVimMode(false)
  362. continue
  363. default:
  364. usage()
  365. continue
  366. }
  367. } else {
  368. usage()
  369. continue
  370. }
  371. }
  372. } else {
  373. usage()
  374. continue
  375. }
  376. case strings.HasPrefix(line, "/show"):
  377. args := strings.Fields(line)
  378. if len(args) > 1 {
  379. mp := server.ParseModelPath(model)
  380. manifest, err := server.GetManifest(mp)
  381. if err != nil {
  382. fmt.Printf("error: couldn't get a manifestfor this model")
  383. continue
  384. }
  385. switch args[1] {
  386. case "license":
  387. for _, l := range manifest.Layers {
  388. if l.MediaType == "application/vnd.ollama.image.license" {
  389. showLayer(l)
  390. }
  391. }
  392. continue
  393. case "system":
  394. for _, l := range manifest.Layers {
  395. if l.MediaType == "application/vnd.ollama.image.system" {
  396. showLayer(l)
  397. }
  398. }
  399. continue
  400. case "template":
  401. for _, l := range manifest.Layers {
  402. if l.MediaType == "application/vnd.ollama.image.template" {
  403. showLayer(l)
  404. }
  405. }
  406. continue
  407. default:
  408. usage()
  409. continue
  410. }
  411. } else {
  412. usage()
  413. continue
  414. }
  415. case line == "/help", line == "/?":
  416. usage()
  417. continue
  418. case line == "/exit", line == "/bye":
  419. return nil
  420. }
  421. if err := generate(cmd, model, line); err != nil {
  422. return err
  423. }
  424. }
  425. }
  426. func generateBatch(cmd *cobra.Command, model string) error {
  427. scanner := bufio.NewScanner(os.Stdin)
  428. for scanner.Scan() {
  429. prompt := scanner.Text()
  430. fmt.Printf(">>> %s\n", prompt)
  431. if err := generate(cmd, model, prompt); err != nil {
  432. return err
  433. }
  434. }
  435. return nil
  436. }
  437. func RunServer(_ *cobra.Command, _ []string) error {
  438. host := os.Getenv("OLLAMA_HOST")
  439. if host == "" {
  440. host = "127.0.0.1"
  441. }
  442. port := os.Getenv("OLLAMA_PORT")
  443. if port == "" {
  444. port = "11434"
  445. }
  446. ln, err := net.Listen("tcp", fmt.Sprintf("%s:%s", host, port))
  447. if err != nil {
  448. return err
  449. }
  450. return server.Serve(ln)
  451. }
  452. func startMacApp(client *api.Client) error {
  453. exe, err := os.Executable()
  454. if err != nil {
  455. return err
  456. }
  457. link, err := os.Readlink(exe)
  458. if err != nil {
  459. return err
  460. }
  461. if !strings.Contains(link, "Ollama.app") {
  462. return fmt.Errorf("could not find ollama app")
  463. }
  464. path := strings.Split(link, "Ollama.app")
  465. if err := exec.Command("/usr/bin/open", "-a", path[0]+"Ollama.app").Run(); err != nil {
  466. return err
  467. }
  468. // wait for the server to start
  469. timeout := time.After(5 * time.Second)
  470. tick := time.Tick(500 * time.Millisecond)
  471. for {
  472. select {
  473. case <-timeout:
  474. return errors.New("timed out waiting for server to start")
  475. case <-tick:
  476. if err := client.Heartbeat(context.Background()); err == nil {
  477. return nil // server has started
  478. }
  479. }
  480. }
  481. }
  482. func checkServerHeartbeat(_ *cobra.Command, _ []string) error {
  483. client := api.NewClient()
  484. if err := client.Heartbeat(context.Background()); err != nil {
  485. if !strings.Contains(err.Error(), "connection refused") {
  486. return err
  487. }
  488. if runtime.GOOS == "darwin" {
  489. if err := startMacApp(client); err != nil {
  490. return fmt.Errorf("could not connect to ollama app, is it running?")
  491. }
  492. } else {
  493. return fmt.Errorf("could not connect to ollama server, run 'ollama serve' to start it")
  494. }
  495. }
  496. return nil
  497. }
  498. func NewCLI() *cobra.Command {
  499. log.SetFlags(log.LstdFlags | log.Lshortfile)
  500. rootCmd := &cobra.Command{
  501. Use: "ollama",
  502. Short: "Large language model runner",
  503. SilenceUsage: true,
  504. CompletionOptions: cobra.CompletionOptions{
  505. DisableDefaultCmd: true,
  506. },
  507. }
  508. cobra.EnableCommandSorting = false
  509. createCmd := &cobra.Command{
  510. Use: "create MODEL",
  511. Short: "Create a model from a Modelfile",
  512. Args: cobra.MinimumNArgs(1),
  513. PreRunE: checkServerHeartbeat,
  514. RunE: CreateHandler,
  515. }
  516. createCmd.Flags().StringP("file", "f", "Modelfile", "Name of the Modelfile (default \"Modelfile\")")
  517. runCmd := &cobra.Command{
  518. Use: "run MODEL [PROMPT]",
  519. Short: "Run a model",
  520. Args: cobra.MinimumNArgs(1),
  521. PreRunE: checkServerHeartbeat,
  522. RunE: RunHandler,
  523. }
  524. runCmd.Flags().Bool("verbose", false, "Show timings for response")
  525. serveCmd := &cobra.Command{
  526. Use: "serve",
  527. Aliases: []string{"start"},
  528. Short: "Start ollama",
  529. RunE: RunServer,
  530. }
  531. pullCmd := &cobra.Command{
  532. Use: "pull MODEL",
  533. Short: "Pull a model from a registry",
  534. Args: cobra.MinimumNArgs(1),
  535. PreRunE: checkServerHeartbeat,
  536. RunE: PullHandler,
  537. }
  538. pullCmd.Flags().Bool("insecure", false, "Use an insecure registry")
  539. pushCmd := &cobra.Command{
  540. Use: "push MODEL",
  541. Short: "Push a model to a registry",
  542. Args: cobra.MinimumNArgs(1),
  543. PreRunE: checkServerHeartbeat,
  544. RunE: PushHandler,
  545. }
  546. pushCmd.Flags().Bool("insecure", false, "Use an insecure registry")
  547. listCmd := &cobra.Command{
  548. Use: "list",
  549. Aliases: []string{"ls"},
  550. Short: "List models",
  551. PreRunE: checkServerHeartbeat,
  552. RunE: ListHandler,
  553. }
  554. copyCmd := &cobra.Command{
  555. Use: "cp",
  556. Short: "Copy a model",
  557. Args: cobra.MinimumNArgs(2),
  558. PreRunE: checkServerHeartbeat,
  559. RunE: CopyHandler,
  560. }
  561. deleteCmd := &cobra.Command{
  562. Use: "rm",
  563. Short: "Remove a model",
  564. Args: cobra.MinimumNArgs(1),
  565. PreRunE: checkServerHeartbeat,
  566. RunE: DeleteHandler,
  567. }
  568. rootCmd.AddCommand(
  569. serveCmd,
  570. createCmd,
  571. runCmd,
  572. pullCmd,
  573. pushCmd,
  574. listCmd,
  575. copyCmd,
  576. deleteCmd,
  577. )
  578. return rootCmd
  579. }