custom

package

v1.18.2 Latest Latest Go to latest Published: Sep 24, 2026 License: Apache-2.0 Imports: 46 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/openai/openai-cli

Links

Open Source Insights

Documentation ¶

Rendered for

Index ¶

Constants
Variables
func ConfigureCommand(root *cli.Command)
func ConfigureHelp(root *cli.Command, args []string) ([]string, bool, error)
func FlagOptions(cmd *cli.Command, nestedFormat apiquery.NestedQueryFormat, ...) (options []option.RequestOption, err error)
func GetDefaultRequestOptions(cmd *cli.Command) []option.RequestOption
func NewRequestHeaderFlag() cli.Flag
func ShowJSON(res gjson.Result, opts ShowJSONOpts) error
func ShowJSONIterator[T any](iter jsonview.Iterator[T], itemsToDisplay int64, opts ShowJSONOpts) error
func ValidateBaseURL(value, source string) error
func WriteBinaryResponse(response *http.Response, stdout io.Writer, outfile string) (string, error)
type BodyContentType
type FileEmbedStyle
type FilePathValue
type OutputKind
type ShowJSONOpts

Constants ¶

View Source

const (
	OutputUnspecified = transformers.OutputUnspecified
	OutputResponse    = transformers.OutputResponse
	OutputPageItem    = transformers.OutputPageItem
	OutputStreamEvent = transformers.OutputStreamEvent
)

View Source

const Version = "1.18.2" // x-release-please-version

Variables ¶

View Source

var OutputFormats = []string{"auto", "explore", "json", "jsonl", "pretty", "raw", "yaml"}

Functions ¶

func ConfigureCommand ¶

func ConfigureCommand(root *cli.Command)

ConfigureCommand installs SDK-owned behavior after the generated command tree is complete.

func ConfigureHelp ¶ added in v1.18.0

func ConfigureHelp(root *cli.Command, args []string) ([]string, bool, error)

ConfigureHelp decorates help without changing API commands or their defaults.

func FlagOptions ¶

func FlagOptions(
	cmd *cli.Command,
	nestedFormat apiquery.NestedQueryFormat,
	arrayFormat apiquery.ArrayQueryFormat,
	bodyType BodyContentType,

	ignoreStdin bool,
) (options []option.RequestOption, err error)

func GetDefaultRequestOptions ¶

func GetDefaultRequestOptions(cmd *cli.Command) []option.RequestOption

func NewRequestHeaderFlag ¶

func NewRequestHeaderFlag() cli.Flag

NewRequestHeaderFlag returns the repeatable, global flag for literal HTTP headers.

func ShowJSON ¶

func ShowJSON(res gjson.Result, opts ShowJSONOpts) error

ShowJSON displays a single JSON result to the user.

func ShowJSONIterator ¶

func ShowJSONIterator[T any](iter jsonview.Iterator[T], itemsToDisplay int64, opts ShowJSONOpts) error

ShowJSONIterator displays an iterator of values to the user. Use itemsToDisplay = -1 for no limit.

func ValidateBaseURL ¶

func ValidateBaseURL(value, source string) error

ValidateBaseURL checks that a base URL is correctly prefixed with a protocol scheme and produces a better error message than the person would see otherwise if it doesn't.

func WriteBinaryResponse ¶

func WriteBinaryResponse(response *http.Response, stdout io.Writer, outfile string) (string, error)

WriteBinaryResponse writes a binary response to stdout or a file.

Takes in a stdout reference so we can test this function without overriding os.Stdout in tests.

Types ¶

type BodyContentType ¶

type BodyContentType int

const (
	EmptyBody BodyContentType = iota
	MultipartFormEncoded
	ApplicationJSON
	ApplicationOctetStream
)

type FileEmbedStyle ¶

type FileEmbedStyle int

const (
	// EmbedText reads referenced files fully into memory and substitutes the file's contents back into the
	// value as a string. Binary files are base64-encoded. Used for JSON request bodies and for headers and
	// query parameters, where the file contents need to be serialized inline.
	EmbedText FileEmbedStyle = iota

	// EmbedIOReader replaces file references with an io.Reader that streams the file's contents. Used for
	// `multipart/form-data` and `application/octet-stream` request bodies, where files are uploaded as binary
	// parts rather than embedded into a text value.
	EmbedIOReader
)

type FilePathValue ¶

type FilePathValue string

FilePathValue is a string wrapper that marks a value as a file path whose contents should be read and embedded in the request. Unlike a regular string, embedFilesValue always treats a FilePathValue as a file path without needing the "@" prefix.

type OutputKind ¶

type OutputKind = transformers.OutputKind

type ShowJSONOpts ¶

type ShowJSONOpts struct {
	Context        context.Context // request cancellation; defaults to context.Background()
	Operation      string          // generated operation identifier; empty for error presentation
	OutputKind     OutputKind      // response, page item, or stream event; unspecified for errors
	ExplicitFormat bool            // true if the user explicitly passed --format
	Format         string          // output format (auto, explore, json, jsonl, pretty, raw, yaml)
	RawOutput      bool            // like jq -r: print strings without JSON quotes
	Stderr         io.Writer       // stderr for warnings; injectable for testing; defaults to os.Stderr
	Stdout         *os.File        // stdout (or pager); injectable for testing; defaults to os.Stdout
	Title          string          // display title
	Transform      string          // GJSON path to extract before displaying
}

ShowJSONOpts configures how JSON output is displayed.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL