ollama/cmd/cmd.go

1059 lines
23 KiB
Go
Raw Normal View History

package cmd
import (
"archive/zip"
2023-11-14 22:07:40 +00:00
"bytes"
"context"
"crypto/ed25519"
"crypto/rand"
2023-11-14 22:07:40 +00:00
"crypto/sha256"
"encoding/pem"
2023-07-06 22:43:04 +00:00
"errors"
2023-07-06 16:24:49 +00:00
"fmt"
2023-07-18 21:01:19 +00:00
"io"
"log"
"net"
"net/http"
"os"
"os/signal"
"path/filepath"
"runtime"
2023-07-07 17:12:58 +00:00
"strings"
"syscall"
2023-07-06 22:43:04 +00:00
"time"
"github.com/containerd/console"
2023-07-18 16:09:45 +00:00
"github.com/olekukonko/tablewriter"
2023-07-06 20:49:31 +00:00
"github.com/spf13/cobra"
"golang.org/x/crypto/ssh"
"golang.org/x/exp/slices"
"golang.org/x/term"
2023-07-06 20:49:31 +00:00
"github.com/ollama/ollama/api"
"github.com/ollama/ollama/format"
"github.com/ollama/ollama/parser"
"github.com/ollama/ollama/progress"
"github.com/ollama/ollama/server"
"github.com/ollama/ollama/version"
)
2023-07-20 23:09:23 +00:00
func CreateHandler(cmd *cobra.Command, args []string) error {
filename, _ := cmd.Flags().GetString("file")
filename, err := filepath.Abs(filename)
if err != nil {
return err
}
2023-10-09 19:18:26 +00:00
client, err := api.ClientFromEnvironment()
if err != nil {
return err
}
2023-11-15 00:33:24 +00:00
p := progress.NewProgress(os.Stderr)
defer p.Stop()
bars := make(map[string]*progress.Bar)
2023-11-14 22:07:40 +00:00
modelfile, err := os.ReadFile(filename)
if err != nil {
return err
}
commands, err := parser.Parse(bytes.NewReader(modelfile))
if err != nil {
return err
}
home, err := os.UserHomeDir()
if err != nil {
return err
}
status := "transferring model data"
spinner := progress.NewSpinner(status)
2023-11-16 00:59:49 +00:00
p.Add(status, spinner)
2023-11-14 22:07:40 +00:00
for _, c := range commands {
switch c.Name {
case "model", "adapter":
path := c.Args
if path == "~" {
path = home
} else if strings.HasPrefix(path, "~/") {
path = filepath.Join(home, path[2:])
}
if !filepath.IsAbs(path) {
path = filepath.Join(filepath.Dir(filename), path)
}
fi, err := os.Stat(path)
2023-11-14 22:07:40 +00:00
if errors.Is(err, os.ErrNotExist) && c.Name == "model" {
2023-11-15 18:57:09 +00:00
continue
2023-11-14 22:07:40 +00:00
} else if err != nil {
return err
}
// TODO make this work w/ adapters
if fi.IsDir() {
tf, err := os.CreateTemp("", "ollama-tf")
if err != nil {
return err
}
defer os.RemoveAll(tf.Name())
zf := zip.NewWriter(tf)
files, err := filepath.Glob(filepath.Join(path, "model-*.safetensors"))
if err != nil {
return err
}
if len(files) == 0 {
return fmt.Errorf("no safetensors files were found in '%s'", path)
}
// add the safetensor config file + tokenizer
files = append(files, filepath.Join(path, "config.json"))
files = append(files, filepath.Join(path, "added_tokens.json"))
files = append(files, filepath.Join(path, "tokenizer.model"))
for _, fn := range files {
f, err := os.Open(fn)
if os.IsNotExist(err) && strings.HasSuffix(fn, "added_tokens.json") {
continue
} else if err != nil {
return err
}
fi, err := f.Stat()
if err != nil {
return err
}
h, err := zip.FileInfoHeader(fi)
if err != nil {
return err
}
h.Name = filepath.Base(fn)
h.Method = zip.Store
w, err := zf.CreateHeader(h)
if err != nil {
return err
}
_, err = io.Copy(w, f)
if err != nil {
return err
}
}
if err := zf.Close(); err != nil {
return err
}
if err := tf.Close(); err != nil {
return err
}
path = tf.Name()
2023-11-14 22:07:40 +00:00
}
digest, err := createBlob(cmd, client, path)
if err != nil {
2023-11-14 22:07:40 +00:00
return err
}
2023-11-15 18:59:38 +00:00
modelfile = bytes.ReplaceAll(modelfile, []byte(c.Args), []byte("@"+digest))
2023-11-14 22:07:40 +00:00
}
}
2023-07-17 21:14:41 +00:00
fn := func(resp api.ProgressResponse) error {
2023-11-15 00:33:24 +00:00
if resp.Digest != "" {
spinner.Stop()
bar, ok := bars[resp.Digest]
if !ok {
bar = progress.NewBar(fmt.Sprintf("pulling %s...", resp.Digest[7:19]), resp.Total, resp.Completed)
2023-11-15 00:33:24 +00:00
bars[resp.Digest] = bar
p.Add(resp.Digest, bar)
}
bar.Set(resp.Completed)
} else if status != resp.Status {
spinner.Stop()
status = resp.Status
spinner = progress.NewSpinner(status)
p.Add(status, spinner)
}
return nil
}
request := api.CreateRequest{Name: args[0], Modelfile: string(modelfile)}
2023-10-12 22:56:40 +00:00
if err := client.Create(cmd.Context(), &request, fn); err != nil {
return err
}
return nil
}
func createBlob(cmd *cobra.Command, client *api.Client, path string) (string, error) {
bin, err := os.Open(path)
if err != nil {
return "", err
}
defer bin.Close()
hash := sha256.New()
if _, err := io.Copy(hash, bin); err != nil {
return "", err
}
if _, err := bin.Seek(0, io.SeekStart); err != nil {
return "", err
}
digest := fmt.Sprintf("sha256:%x", hash.Sum(nil))
if err = client.CreateBlob(cmd.Context(), digest, bin); err != nil {
return "", err
}
return digest, nil
}
func RunHandler(cmd *cobra.Command, args []string) error {
if os.Getenv("OLLAMA_MODELS") != "" {
return errors.New("OLLAMA_MODELS must only be set for 'ollama serve'")
}
if err := checkServerHeartbeat(cmd, args); err != nil {
return err
}
2023-10-09 19:18:26 +00:00
client, err := api.ClientFromEnvironment()
2023-08-22 04:56:56 +00:00
if err != nil {
return err
}
name := args[0]
// check if the model exists on the server
show, err := client.Show(cmd.Context(), &api.ShowRequest{Name: name})
2023-11-01 03:49:48 +00:00
var statusError api.StatusError
switch {
case errors.As(err, &statusError) && statusError.StatusCode == http.StatusNotFound:
if err := PullHandler(cmd, []string{name}); err != nil {
return err
2023-07-06 22:43:04 +00:00
}
show, err = client.Show(cmd.Context(), &api.ShowRequest{Name: name})
if err != nil {
return err
}
2023-11-01 03:49:48 +00:00
case err != nil:
return err
}
interactive := true
opts := runOptions{
Model: args[0],
WordWrap: os.Getenv("TERM") == "xterm-256color",
Options: map[string]interface{}{},
MultiModal: slices.Contains(show.Details.Families, "clip"),
ParentModel: show.Details.ParentModel,
}
format, err := cmd.Flags().GetString("format")
if err != nil {
return err
}
opts.Format = format
prompts := args[1:]
// prepend stdin to the prompt if provided
if !term.IsTerminal(int(os.Stdin.Fd())) {
in, err := io.ReadAll(os.Stdin)
if err != nil {
return err
}
prompts = append([]string{string(in)}, prompts...)
opts.WordWrap = false
interactive = false
}
opts.Prompt = strings.Join(prompts, " ")
if len(prompts) > 0 {
interactive = false
}
nowrap, err := cmd.Flags().GetBool("nowordwrap")
if err != nil {
return err
}
opts.WordWrap = !nowrap
if !interactive {
return generate(cmd, opts)
}
return generateInteractive(cmd, opts)
2023-07-06 18:18:40 +00:00
}
2023-07-20 23:09:23 +00:00
func PushHandler(cmd *cobra.Command, args []string) error {
2023-10-09 19:18:26 +00:00
client, err := api.ClientFromEnvironment()
if err != nil {
return err
}
insecure, err := cmd.Flags().GetBool("insecure")
if err != nil {
return err
}
2023-11-15 00:33:24 +00:00
p := progress.NewProgress(os.Stderr)
defer p.Stop()
bars := make(map[string]*progress.Bar)
var status string
var spinner *progress.Spinner
2023-11-15 00:33:24 +00:00
2023-07-19 01:51:30 +00:00
fn := func(resp api.ProgressResponse) error {
2023-11-15 00:33:24 +00:00
if resp.Digest != "" {
if spinner != nil {
spinner.Stop()
}
2023-11-15 00:33:24 +00:00
bar, ok := bars[resp.Digest]
if !ok {
bar = progress.NewBar(fmt.Sprintf("pushing %s...", resp.Digest[7:19]), resp.Total, resp.Completed)
2023-11-15 00:33:24 +00:00
bars[resp.Digest] = bar
p.Add(resp.Digest, bar)
}
bar.Set(resp.Completed)
} else if status != resp.Status {
if spinner != nil {
spinner.Stop()
}
2023-11-15 00:33:24 +00:00
status = resp.Status
spinner = progress.NewSpinner(status)
p.Add(status, spinner)
}
return nil
}
2023-11-15 00:33:24 +00:00
request := api.PushRequest{Name: args[0], Insecure: insecure}
2023-10-12 22:56:40 +00:00
if err := client.Push(cmd.Context(), &request, fn); err != nil {
2023-11-15 00:33:24 +00:00
return err
}
2023-11-16 00:59:49 +00:00
spinner.Stop()
2023-11-15 00:33:24 +00:00
return nil
}
2023-07-20 23:09:23 +00:00
func ListHandler(cmd *cobra.Command, args []string) error {
2023-10-09 19:18:26 +00:00
client, err := api.ClientFromEnvironment()
if err != nil {
return err
}
2023-07-18 16:09:45 +00:00
2023-10-12 22:56:40 +00:00
models, err := client.List(cmd.Context())
2023-07-18 16:09:45 +00:00
if err != nil {
return err
}
var data [][]string
for _, m := range models.Models {
2023-07-18 21:01:19 +00:00
if len(args) == 0 || strings.HasPrefix(m.Name, args[0]) {
data = append(data, []string{m.Name, m.Digest[:12], format.HumanBytes(m.Size), format.HumanTime(m.ModifiedAt, "Never")})
2023-07-18 21:01:19 +00:00
}
2023-07-18 16:09:45 +00:00
}
table := tablewriter.NewWriter(os.Stdout)
2023-08-29 03:50:24 +00:00
table.SetHeader([]string{"NAME", "ID", "SIZE", "MODIFIED"})
2023-07-18 16:09:45 +00:00
table.SetHeaderAlignment(tablewriter.ALIGN_LEFT)
table.SetAlignment(tablewriter.ALIGN_LEFT)
table.SetHeaderLine(false)
table.SetBorder(false)
table.SetNoWhiteSpace(true)
table.SetTablePadding("\t")
table.AppendBulk(data)
table.Render()
return nil
}
2023-07-20 23:09:23 +00:00
func DeleteHandler(cmd *cobra.Command, args []string) error {
2023-10-09 19:18:26 +00:00
client, err := api.ClientFromEnvironment()
if err != nil {
return err
}
2023-07-20 23:09:23 +00:00
for _, name := range args {
req := api.DeleteRequest{Name: name}
2023-10-12 22:56:40 +00:00
if err := client.Delete(cmd.Context(), &req); err != nil {
return err
}
fmt.Printf("deleted '%s'\n", name)
2023-07-20 23:09:23 +00:00
}
return nil
}
2023-09-06 18:04:17 +00:00
func ShowHandler(cmd *cobra.Command, args []string) error {
2023-10-09 19:18:26 +00:00
client, err := api.ClientFromEnvironment()
2023-09-06 18:04:17 +00:00
if err != nil {
return err
}
if len(args) != 1 {
return errors.New("missing model name")
}
license, errLicense := cmd.Flags().GetBool("license")
modelfile, errModelfile := cmd.Flags().GetBool("modelfile")
parameters, errParams := cmd.Flags().GetBool("parameters")
system, errSystem := cmd.Flags().GetBool("system")
template, errTemplate := cmd.Flags().GetBool("template")
for _, boolErr := range []error{errLicense, errModelfile, errParams, errSystem, errTemplate} {
if boolErr != nil {
return errors.New("error retrieving flags")
}
}
flagsSet := 0
showType := ""
if license {
flagsSet++
showType = "license"
}
if modelfile {
flagsSet++
showType = "modelfile"
}
if parameters {
flagsSet++
showType = "parameters"
}
if system {
flagsSet++
showType = "system"
}
if template {
flagsSet++
showType = "template"
}
if flagsSet > 1 {
return errors.New("only one of '--license', '--modelfile', '--parameters', '--system', or '--template' can be specified")
2023-09-06 18:04:17 +00:00
} else if flagsSet == 0 {
return errors.New("one of '--license', '--modelfile', '--parameters', '--system', or '--template' must be specified")
2023-09-06 18:04:17 +00:00
}
req := api.ShowRequest{Name: args[0]}
2023-10-12 22:56:40 +00:00
resp, err := client.Show(cmd.Context(), &req)
2023-09-06 18:04:17 +00:00
if err != nil {
return err
}
switch showType {
case "license":
fmt.Println(resp.License)
case "modelfile":
fmt.Println(resp.Modelfile)
case "parameters":
fmt.Println(resp.Parameters)
case "system":
fmt.Println(resp.System)
case "template":
fmt.Println(resp.Template)
}
return nil
}
2023-07-24 15:27:28 +00:00
func CopyHandler(cmd *cobra.Command, args []string) error {
2023-10-09 19:18:26 +00:00
client, err := api.ClientFromEnvironment()
if err != nil {
return err
}
2023-07-24 15:27:28 +00:00
req := api.CopyRequest{Source: args[0], Destination: args[1]}
2023-10-12 22:56:40 +00:00
if err := client.Copy(cmd.Context(), &req); err != nil {
2023-07-24 15:27:28 +00:00
return err
}
fmt.Printf("copied '%s' to '%s'\n", args[0], args[1])
return nil
}
2023-07-20 23:09:23 +00:00
func PullHandler(cmd *cobra.Command, args []string) error {
insecure, err := cmd.Flags().GetBool("insecure")
if err != nil {
return err
}
2023-10-09 19:18:26 +00:00
client, err := api.ClientFromEnvironment()
if err != nil {
return err
}
2023-11-15 00:33:24 +00:00
p := progress.NewProgress(os.Stderr)
defer p.Stop()
bars := make(map[string]*progress.Bar)
var status string
var spinner *progress.Spinner
2023-11-15 00:33:24 +00:00
2023-07-19 01:51:30 +00:00
fn := func(resp api.ProgressResponse) error {
2023-11-15 00:33:24 +00:00
if resp.Digest != "" {
if spinner != nil {
spinner.Stop()
}
2023-11-15 00:33:24 +00:00
bar, ok := bars[resp.Digest]
if !ok {
bar = progress.NewBar(fmt.Sprintf("pulling %s...", resp.Digest[7:19]), resp.Total, resp.Completed)
2023-11-15 00:33:24 +00:00
bars[resp.Digest] = bar
p.Add(resp.Digest, bar)
}
bar.Set(resp.Completed)
} else if status != resp.Status {
if spinner != nil {
spinner.Stop()
}
2023-11-15 00:33:24 +00:00
status = resp.Status
spinner = progress.NewSpinner(status)
p.Add(status, spinner)
}
return nil
}
2023-07-07 14:22:37 +00:00
2023-11-15 00:33:24 +00:00
request := api.PullRequest{Name: args[0], Insecure: insecure}
2023-10-12 22:56:40 +00:00
if err := client.Pull(cmd.Context(), &request, fn); err != nil {
2023-11-15 00:33:24 +00:00
return err
}
return nil
2023-07-06 20:49:31 +00:00
}
type generateContextKey string
type runOptions struct {
2024-01-25 20:12:36 +00:00
Model string
ParentModel string
Prompt string
Messages []api.Message
WordWrap bool
Format string
System string
Template string
Images []api.ImageData
Options map[string]interface{}
MultiModal bool
}
type displayResponseState struct {
lineLength int
wordBuffer string
}
func displayResponse(content string, wordWrap bool, state *displayResponseState) {
termWidth, _, _ := term.GetSize(int(os.Stdout.Fd()))
if wordWrap && termWidth >= 10 {
for _, ch := range content {
if state.lineLength+1 > termWidth-5 {
if len(state.wordBuffer) > termWidth-10 {
fmt.Printf("%s%c", state.wordBuffer, ch)
state.wordBuffer = ""
state.lineLength = 0
continue
}
// backtrack the length of the last word and clear to the end of the line
fmt.Printf("\x1b[%dD\x1b[K\n", len(state.wordBuffer))
fmt.Printf("%s%c", state.wordBuffer, ch)
state.lineLength = len(state.wordBuffer) + 1
} else {
fmt.Print(string(ch))
state.lineLength += 1
switch ch {
case ' ':
state.wordBuffer = ""
case '\n':
state.lineLength = 0
default:
state.wordBuffer += string(ch)
}
}
}
} else {
fmt.Printf("%s%s", state.wordBuffer, content)
if len(state.wordBuffer) > 0 {
state.wordBuffer = ""
}
}
}
func chat(cmd *cobra.Command, opts runOptions) (*api.Message, error) {
client, err := api.ClientFromEnvironment()
if err != nil {
return nil, err
}
p := progress.NewProgress(os.Stderr)
defer p.StopAndClear()
spinner := progress.NewSpinner("")
p.Add("", spinner)
cancelCtx, cancel := context.WithCancel(cmd.Context())
defer cancel()
sigChan := make(chan os.Signal, 1)
signal.Notify(sigChan, syscall.SIGINT)
go func() {
<-sigChan
cancel()
}()
var state *displayResponseState = &displayResponseState{}
var latest api.ChatResponse
var fullResponse strings.Builder
var role string
fn := func(response api.ChatResponse) error {
p.StopAndClear()
latest = response
role = response.Message.Role
content := response.Message.Content
fullResponse.WriteString(content)
displayResponse(content, opts.WordWrap, state)
return nil
}
req := &api.ChatRequest{
Model: opts.Model,
Messages: opts.Messages,
Format: opts.Format,
Options: opts.Options,
}
if err := client.Chat(cancelCtx, req, fn); err != nil {
if errors.Is(err, context.Canceled) {
return nil, nil
}
return nil, err
}
if len(opts.Messages) > 0 {
fmt.Println()
fmt.Println()
}
verbose, err := cmd.Flags().GetBool("verbose")
if err != nil {
return nil, err
}
if verbose {
latest.Summary()
}
return &api.Message{Role: role, Content: fullResponse.String()}, nil
}
func generate(cmd *cobra.Command, opts runOptions) error {
2023-10-09 19:18:26 +00:00
client, err := api.ClientFromEnvironment()
2023-09-18 19:26:56 +00:00
if err != nil {
return err
2023-09-18 19:26:56 +00:00
}
2023-07-07 17:12:58 +00:00
2023-11-15 00:58:51 +00:00
p := progress.NewProgress(os.Stderr)
defer p.StopAndClear()
2023-11-15 00:58:51 +00:00
spinner := progress.NewSpinner("")
p.Add("", spinner)
var latest api.GenerateResponse
generateContext, ok := cmd.Context().Value(generateContextKey("context")).([]int)
if !ok {
generateContext = []int{}
}
2023-10-12 22:56:40 +00:00
ctx, cancel := context.WithCancel(cmd.Context())
defer cancel()
sigChan := make(chan os.Signal, 1)
signal.Notify(sigChan, syscall.SIGINT)
go func() {
<-sigChan
cancel()
}()
var state *displayResponseState = &displayResponseState{}
fn := func(response api.GenerateResponse) error {
2023-11-15 00:58:51 +00:00
p.StopAndClear()
2023-09-18 19:26:56 +00:00
latest = response
content := response.Response
2023-07-13 01:18:06 +00:00
displayResponse(content, opts.WordWrap, state)
2023-09-18 19:26:56 +00:00
return nil
}
2023-07-07 21:04:43 +00:00
if opts.MultiModal {
opts.Prompt, opts.Images, err = extractFileData(opts.Prompt)
if err != nil {
return err
}
}
2023-10-12 22:56:40 +00:00
request := api.GenerateRequest{
Model: opts.Model,
Prompt: opts.Prompt,
Context: generateContext,
Images: opts.Images,
2023-10-12 22:56:40 +00:00
Format: opts.Format,
System: opts.System,
Template: opts.Template,
Options: opts.Options,
}
if err := client.Generate(ctx, &request, fn); err != nil {
if errors.Is(err, context.Canceled) {
return nil
2023-07-07 21:04:43 +00:00
}
return err
2023-09-18 19:26:56 +00:00
}
if opts.Prompt != "" {
2023-07-07 17:12:58 +00:00
fmt.Println()
fmt.Println()
2023-09-18 19:26:56 +00:00
}
2023-07-13 01:18:06 +00:00
if !latest.Done {
return nil
}
2023-09-18 19:26:56 +00:00
verbose, err := cmd.Flags().GetBool("verbose")
if err != nil {
return err
2023-09-18 19:26:56 +00:00
}
2023-07-18 18:59:42 +00:00
2023-09-18 19:26:56 +00:00
if verbose {
latest.Summary()
2023-07-07 17:12:58 +00:00
}
2023-07-06 20:49:31 +00:00
ctx = context.WithValue(cmd.Context(), generateContextKey("context"), latest.Context)
cmd.SetContext(ctx)
return nil
2023-07-06 20:49:31 +00:00
}
func RunServer(cmd *cobra.Command, _ []string) error {
host, port, err := net.SplitHostPort(strings.Trim(os.Getenv("OLLAMA_HOST"), "\"'"))
2023-09-21 00:49:48 +00:00
if err != nil {
host, port = "127.0.0.1", "11434"
2023-09-22 17:40:54 +00:00
if ip := net.ParseIP(strings.Trim(os.Getenv("OLLAMA_HOST"), "[]")); ip != nil {
2023-09-21 00:49:48 +00:00
host = ip.String()
}
2023-07-04 04:47:00 +00:00
}
2023-09-21 00:49:48 +00:00
if err := initializeKeypair(); err != nil {
return err
}
2023-09-21 00:49:48 +00:00
ln, err := net.Listen("tcp", net.JoinHostPort(host, port))
if err != nil {
return err
}
2023-07-04 04:47:00 +00:00
2023-12-15 00:47:40 +00:00
return server.Serve(ln)
2023-07-04 04:47:00 +00:00
}
func initializeKeypair() error {
home, err := os.UserHomeDir()
if err != nil {
return err
}
privKeyPath := filepath.Join(home, ".ollama", "id_ed25519")
pubKeyPath := filepath.Join(home, ".ollama", "id_ed25519.pub")
_, err = os.Stat(privKeyPath)
if os.IsNotExist(err) {
fmt.Printf("Couldn't find '%s'. Generating new private key.\n", privKeyPath)
cryptoPublicKey, cryptoPrivateKey, err := ed25519.GenerateKey(rand.Reader)
if err != nil {
return err
}
privateKeyBytes, err := ssh.MarshalPrivateKey(cryptoPrivateKey, "")
if err != nil {
return err
}
if err := os.MkdirAll(filepath.Dir(privKeyPath), 0o755); err != nil {
return fmt.Errorf("could not create directory %w", err)
}
if err := os.WriteFile(privKeyPath, pem.EncodeToMemory(privateKeyBytes), 0o600); err != nil {
return err
}
sshPublicKey, err := ssh.NewPublicKey(cryptoPublicKey)
if err != nil {
return err
}
publicKeyBytes := ssh.MarshalAuthorizedKey(sshPublicKey)
if err := os.WriteFile(pubKeyPath, publicKeyBytes, 0o644); err != nil {
return err
}
fmt.Printf("Your new public key is: \n\n%s\n", publicKeyBytes)
}
return nil
}
//nolint:unused
func waitForServer(ctx context.Context, client *api.Client) error {
2023-07-31 21:38:10 +00:00
// wait for the server to start
timeout := time.After(5 * time.Second)
tick := time.Tick(500 * time.Millisecond)
for {
select {
case <-timeout:
return errors.New("timed out waiting for server to start")
case <-tick:
2023-10-12 22:56:40 +00:00
if err := client.Heartbeat(ctx); err == nil {
2023-07-31 21:38:10 +00:00
return nil // server has started
}
}
}
2023-07-31 21:38:10 +00:00
}
2023-10-12 22:56:40 +00:00
func checkServerHeartbeat(cmd *cobra.Command, _ []string) error {
2023-10-09 19:18:26 +00:00
client, err := api.ClientFromEnvironment()
if err != nil {
return err
}
2023-10-12 22:56:40 +00:00
if err := client.Heartbeat(cmd.Context()); err != nil {
if !strings.Contains(err.Error(), " refused") {
2023-07-31 21:38:10 +00:00
return err
}
if err := startApp(cmd.Context(), client); err != nil {
return fmt.Errorf("could not connect to ollama app, is it running?")
}
}
return nil
}
2023-11-22 17:41:02 +00:00
func versionHandler(cmd *cobra.Command, _ []string) {
client, err := api.ClientFromEnvironment()
if err != nil {
return
}
serverVersion, err := client.Version(cmd.Context())
if err != nil {
2023-12-01 20:10:27 +00:00
fmt.Println("Warning: could not connect to a running Ollama instance")
}
if serverVersion != "" {
fmt.Printf("ollama version is %s\n", serverVersion)
2023-11-22 17:41:02 +00:00
}
if serverVersion != version.Version {
2023-12-01 20:10:27 +00:00
fmt.Printf("Warning: client version is %s\n", version.Version)
}
2023-11-22 17:41:02 +00:00
}
func appendHostEnvDocs(cmd *cobra.Command) {
const hostEnvDocs = `
Environment Variables:
OLLAMA_HOST The host:port or base URL of the Ollama server (e.g. http://localhost:11434)
`
cmd.SetUsageTemplate(cmd.UsageTemplate() + hostEnvDocs)
}
func NewCLI() *cobra.Command {
log.SetFlags(log.LstdFlags | log.Lshortfile)
2023-11-22 17:41:02 +00:00
cobra.EnableCommandSorting = false
if runtime.GOOS == "windows" {
console.ConsoleFromFile(os.Stdin) //nolint:errcheck
}
rootCmd := &cobra.Command{
2023-08-14 18:15:53 +00:00
Use: "ollama",
Short: "Large language model runner",
SilenceUsage: true,
SilenceErrors: true,
CompletionOptions: cobra.CompletionOptions{
DisableDefaultCmd: true,
},
2023-11-22 17:41:02 +00:00
Run: func(cmd *cobra.Command, args []string) {
if version, _ := cmd.Flags().GetBool("version"); version {
versionHandler(cmd, args)
return
}
cmd.Print(cmd.UsageString())
},
}
2023-11-22 17:41:02 +00:00
rootCmd.Flags().BoolP("version", "v", false, "Show version information")
createCmd := &cobra.Command{
Use: "create MODEL",
Short: "Create a model from a Modelfile",
2023-10-18 18:57:22 +00:00
Args: cobra.ExactArgs(1),
PreRunE: checkServerHeartbeat,
RunE: CreateHandler,
}
createCmd.Flags().StringP("file", "f", "Modelfile", "Name of the Modelfile (default \"Modelfile\")")
2023-09-06 18:04:17 +00:00
showCmd := &cobra.Command{
Use: "show MODEL",
Short: "Show information for a model",
2023-10-18 18:57:22 +00:00
Args: cobra.ExactArgs(1),
2023-09-06 18:04:17 +00:00
PreRunE: checkServerHeartbeat,
RunE: ShowHandler,
}
showCmd.Flags().Bool("license", false, "Show license of a model")
showCmd.Flags().Bool("modelfile", false, "Show Modelfile of a model")
showCmd.Flags().Bool("parameters", false, "Show parameters of a model")
showCmd.Flags().Bool("template", false, "Show template of a model")
showCmd.Flags().Bool("system", false, "Show system message of a model")
2023-09-06 18:04:17 +00:00
runCmd := &cobra.Command{
Use: "run MODEL [PROMPT]",
Short: "Run a model",
Args: cobra.MinimumNArgs(1),
RunE: RunHandler,
}
2023-07-13 01:18:06 +00:00
runCmd.Flags().Bool("verbose", false, "Show timings for response")
2023-08-22 04:56:56 +00:00
runCmd.Flags().Bool("insecure", false, "Use an insecure registry")
runCmd.Flags().Bool("nowordwrap", false, "Don't wrap words to the next line automatically")
2023-11-14 02:54:02 +00:00
runCmd.Flags().String("format", "", "Response format (e.g. json)")
serveCmd := &cobra.Command{
Use: "serve",
Aliases: []string{"start"},
Short: "Start ollama",
2023-10-18 18:57:22 +00:00
Args: cobra.ExactArgs(0),
2023-07-06 20:49:31 +00:00
RunE: RunServer,
}
serveCmd.SetUsageTemplate(serveCmd.UsageTemplate() + `
Environment Variables:
OLLAMA_HOST The host:port to bind to (default "127.0.0.1:11434")
OLLAMA_ORIGINS A comma separated list of allowed origins.
OLLAMA_MODELS The path to the models directory (default is "~/.ollama/models")
OLLAMA_KEEP_ALIVE The duration that models stay loaded in memory (default is "5m")
OLLAMA_DEBUG Set to 1 to enable additional debug logging
`)
pullCmd := &cobra.Command{
Use: "pull MODEL",
Short: "Pull a model from a registry",
2023-10-18 18:57:22 +00:00
Args: cobra.ExactArgs(1),
PreRunE: checkServerHeartbeat,
RunE: PullHandler,
}
pullCmd.Flags().Bool("insecure", false, "Use an insecure registry")
pushCmd := &cobra.Command{
Use: "push MODEL",
Short: "Push a model to a registry",
2023-10-18 18:57:22 +00:00
Args: cobra.ExactArgs(1),
PreRunE: checkServerHeartbeat,
RunE: PushHandler,
}
pushCmd.Flags().Bool("insecure", false, "Use an insecure registry")
2023-07-18 16:09:45 +00:00
listCmd := &cobra.Command{
Use: "list",
2023-07-20 22:28:27 +00:00
Aliases: []string{"ls"},
Short: "List models",
PreRunE: checkServerHeartbeat,
RunE: ListHandler,
2023-07-20 23:09:23 +00:00
}
2023-07-24 15:27:28 +00:00
copyCmd := &cobra.Command{
2023-10-18 18:57:22 +00:00
Use: "cp SOURCE TARGET",
Short: "Copy a model",
2023-10-18 18:57:22 +00:00
Args: cobra.ExactArgs(2),
PreRunE: checkServerHeartbeat,
RunE: CopyHandler,
2023-07-24 15:27:28 +00:00
}
2023-07-20 23:09:23 +00:00
deleteCmd := &cobra.Command{
2023-10-18 18:57:22 +00:00
Use: "rm MODEL [MODEL...]",
Short: "Remove a model",
Args: cobra.MinimumNArgs(1),
PreRunE: checkServerHeartbeat,
RunE: DeleteHandler,
2023-07-18 16:09:45 +00:00
}
for _, cmd := range []*cobra.Command{
createCmd,
showCmd,
runCmd,
pullCmd,
pushCmd,
listCmd,
copyCmd,
deleteCmd,
} {
appendHostEnvDocs(cmd)
}
rootCmd.AddCommand(
serveCmd,
createCmd,
2023-09-06 18:04:17 +00:00
showCmd,
runCmd,
pullCmd,
pushCmd,
2023-07-18 16:09:45 +00:00
listCmd,
2023-07-24 15:27:28 +00:00
copyCmd,
2023-07-20 23:09:23 +00:00
deleteCmd,
)
return rootCmd
}