cli

Documentation

Index

• func Main()
• func New() *cobra.Command
• type CacheOptions
• type Credential
  • func (c *Credential) Customize(cmd *cobra.Command)
  • func (c *Credential) Run(cmd *cobra.Command, _ []string) error
• type Delete
  • func (c *Delete) Customize(cmd *cobra.Command)
  • func (c *Delete) Run(cmd *cobra.Command, args []string) error
• type DisplayOptions
• type Eval
  • func (e *Eval) Run(cmd *cobra.Command, args []string) error
• type Fmt
  • func (e *Fmt) Customize(cmd *cobra.Command)
  • func (e *Fmt) Run(_ *cobra.Command, args []string) error
• type GPTScript
  • func (r *GPTScript) Customize(cmd *cobra.Command)
  • func (r *GPTScript) NewGPTScriptOpts() (gptscript.Options, error)
  • func (r *GPTScript) PersistentPre(*cobra.Command, []string) error
  • func (r *GPTScript) PrintOutput(toolInput, toolOutput string) (err error)
  • func (r *GPTScript) Run(cmd *cobra.Command, args []string) (retErr error)
• type Getenv
  • func (e *Getenv) Customize(cmd *cobra.Command)
  • func (e *Getenv) Run(_ *cobra.Command, args []string) error
• type OpenAIOptions
• type Parse
  • func (e *Parse) Customize(cmd *cobra.Command)
  • func (e *Parse) Run(_ *cobra.Command, args []string) error
• type SDKServer
  • func (c *SDKServer) Customize(cmd *cobra.Command)
  • func (c *SDKServer) Run(cmd *cobra.Command, _ []string) error
• type Show
  • func (c *Show) Customize(cmd *cobra.Command)
  • func (c *Show) Run(cmd *cobra.Command, args []string) error

Functions

func Main

func Main()

func New

func New() *cobra.Command

Types

type CacheOptions

type CacheOptions cache.Options

type Credential

type Credential struct {
	AllContexts bool `usage:"List credentials for all contexts" local:"true"`
	ShowEnvVars bool `usage:"Show names of environment variables in each credential" local:"true"`
	// contains filtered or unexported fields
}

func (*Credential) Customize

func (c *Credential) Customize(cmd *cobra.Command)

func (*Credential) Run

func (c *Credential) Run(cmd *cobra.Command, _ []string) error

type Delete

type Delete struct {
	// contains filtered or unexported fields
}

func (*Delete) Customize

func (c *Delete) Customize(cmd *cobra.Command)

func (*Delete) Run

func (c *Delete) Run(cmd *cobra.Command, args []string) error

type DisplayOptions

type DisplayOptions monitor.Options

type Eval

type Eval struct {
	Tools          []string `usage:"Tools available to call"`
	Chat           bool     `usage:"Enable chat"`
	MaxTokens      int      `usage:"Maximum number of tokens to output"`
	Model          string   `usage:"The model to use"`
	JSON           bool     `usage:"Output JSON"`
	Temperature    string   `usage:"Set the temperature, \"creativity\""`
	InternalPrompt *bool    `Usage:"Set to false to disable the internal prompt"`
	// contains filtered or unexported fields
}

func (*Eval) Run

func (e *Eval) Run(cmd *cobra.Command, args []string) error

type Fmt

type Fmt struct {
	Write bool `usage:"Write output to file instead of stdout" short:"w"`
}

func (*Fmt) Customize

func (e *Fmt) Customize(cmd *cobra.Command)

func (*Fmt) Run

func (e *Fmt) Run(_ *cobra.Command, args []string) error

type GPTScript

type GPTScript struct {
	CacheOptions
	OpenAIOptions
	DisplayOptions
	Color          *bool  `usage:"Use color in output (default true)" default:"true"`
	Confirm        bool   `usage:"Prompt before running potentially dangerous commands"`
	Debug          bool   `usage:"Enable debug logging"`
	NoTrunc        bool   `usage:"Do not truncate long log messages"`
	Quiet          *bool  `usage:"No output logging (set --quiet=false to force on even when there is no TTY)" short:"q"`
	Output         string `usage:"Save output to a file, or - for stdout" short:"o"`
	EventsStreamTo string `` /* 164-byte string literal not displayed */
	// Input should not be using GPTSCRIPT_INPUT env var because that is the same value that is set in tool executions
	Input                    string   `usage:"Read input from a file (\"-\" for stdin)" short:"f" env:"GPTSCRIPT_INPUT_FILE"`
	SubTool                  string   `usage:"Use tool of this name, not the first tool in file" local:"true"`
	Assemble                 bool     `usage:"Assemble tool to a single artifact, saved to --output" hidden:"true" local:"true"`
	ListModels               bool     `usage:"List the models available and exit" local:"true"`
	ListTools                bool     `usage:"List built-in tools and exit" local:"true"`
	ListenAddress            string   `usage:"Server listen address" default:"127.0.0.1:0" hidden:"true"`
	Chdir                    string   `usage:"Change current working directory" short:"C"`
	Daemon                   bool     `usage:"Run tool as a daemon" local:"true" hidden:"true"`
	Ports                    string   `usage:"The port range to use for ephemeral daemon ports (ex: 11000-12000)" hidden:"true"`
	CredentialContext        []string `usage:"Context name(s) in which to store credentials"`
	CredentialOverride       []string `usage:"Credentials to override (ex: --credential-override github.com/example/cred-tool:API_TOKEN=1234)"`
	ChatState                string   `usage:"The chat state to continue, or null to start a new chat and return the state" local:"true"`
	ForceChat                bool     `usage:"Force an interactive chat session if even the top level tool is not a chat tool" local:"true"`
	ForceSequential          bool     `usage:"Force parallel calls to run sequentially" local:"true"`
	Workspace                string   `usage:"Directory to use for the workspace, if specified it will not be deleted on exit"`
	UI                       bool     `usage:"Launch the UI" local:"true" name:"ui"`
	DisableTUI               bool     `usage:"Don't use chat TUI but instead verbose output" local:"true" name:"disable-tui"`
	SaveChatStateFile        string   `usage:"A file to save the chat state to so that a conversation can be resumed with --chat-state" local:"true"`
	DefaultModelProvider     string   `usage:"Default LLM model provider to use, this will override OpenAI settings"`
	GithubEnterpriseHostname string   `usage:"The host name for a Github Enterprise instance to enable for remote loading" local:"true"`
	// contains filtered or unexported fields
}

func (*GPTScript) Customize

func (r *GPTScript) Customize(cmd *cobra.Command)

func (*GPTScript) NewGPTScriptOpts

func (r *GPTScript) NewGPTScriptOpts() (gptscript.Options, error)

func (*GPTScript) PersistentPre

func (r *GPTScript) PersistentPre(*cobra.Command, []string) error

func (*GPTScript) PrintOutput

func (r *GPTScript) PrintOutput(toolInput, toolOutput string) (err error)

func (*GPTScript) Run

func (r *GPTScript) Run(cmd *cobra.Command, args []string) (retErr error)

type Getenv

type Getenv struct {
}

func (*Getenv) Customize

func (e *Getenv) Customize(cmd *cobra.Command)

func (*Getenv) Run

func (e *Getenv) Run(_ *cobra.Command, args []string) error

type OpenAIOptions

type OpenAIOptions openai.Options

type Parse

type Parse struct {
	PrettyPrint bool `usage:"Indent the json output" short:"p"`
	// contains filtered or unexported fields
}

func (*Parse) Customize

func (e *Parse) Customize(cmd *cobra.Command)

func (*Parse) Run

func (e *Parse) Run(_ *cobra.Command, args []string) error

type SDKServer

type SDKServer struct {
	*GPTScript
}

func (*SDKServer) Customize

func (c *SDKServer) Customize(cmd *cobra.Command)

func (*SDKServer) Run

func (c *SDKServer) Run(cmd *cobra.Command, _ []string) error

type Show

type Show struct {
	// contains filtered or unexported fields
}

func (*Show) Customize

func (c *Show) Customize(cmd *cobra.Command)

func (*Show) Run

func (c *Show) Run(cmd *cobra.Command, args []string) error