cmd.go 13 KB

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