Documentation
¶
Index ¶
- Constants
- Variables
- 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
- type BodyContentType
- type FileEmbedStyle
- type FilePathValue
- type ShowJSONOpts
Constants ¶
View Source
const Version = "0.27.0" // x-release-please-version
Variables ¶
View Source
var ( Command *cli.Command CommandErrorBuffer bytes.Buffer )
View Source
var OutputFormats = []string{"auto", "explore", "json", "jsonl", "pretty", "raw", "yaml"}
Functions ¶
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 ¶ added in v0.26.0
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.
Types ¶
type BodyContentType ¶
type BodyContentType int
const ( EmptyBody BodyContentType = iota MultipartFormEncoded ApplicationJSON ApplicationOctetStream )
type FileEmbedStyle ¶
type FileEmbedStyle int
const ( EmbedText FileEmbedStyle = iota EmbedIOReader )
type FilePathValue ¶ added in v0.26.0
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 ShowJSONOpts ¶ added in v0.27.0
type ShowJSONOpts struct {
ExplicitFormat bool // true if the user explicitly passed --format
Format string // output format (auto, explore, json, jsonl, pretty, raw, yaml)
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
¶
- agentv1agent.go
- agentv1chat.go
- agentv1chatfile.go
- agentv1execute.go
- agentv1run.go
- agentv2chat.go
- agentv2chatfile.go
- agentv2execute.go
- agentv2run.go
- applicationv1deployment.go
- applicationv1project.go
- applicationv1workflow.go
- cmd.go
- cmdutil.go
- cmdutil_unix.go
- computev1.go
- computev1environment.go
- computev1instance.go
- computev1instancetype.go
- computev1secret.go
- databasev1.go
- databasev1project.go
- flagoptions.go
- formatv1template.go
- legalv1.go
- llm.go
- llmv1.go
- llmv1chat.go
- mailv1inbox.go
- matterv1.go
- matterv1agenttype.go
- matterv1eventsubscription.go
- matterv1log.go
- matterv1matterparty.go
- matterv1party.go
- matterv1share.go
- matterv1type.go
- matterv1workitem.go
- memoryv1.go
- ocrv1.go
- privilegev1.go
- searchv1.go
- skill.go
- skillcustom.go
- suggest.go
- system.go
- translatev1.go
- usagev1.go
- usagev1subscription.go
- vault.go
- vaulteventsubscription.go
- vaultgraphrag.go
- vaultgroup.go
- vaultmemory.go
- vaultmultipart.go
- vaultobject.go
- version.go
- voiceboostlist.go
- voicestreaming.go
- voicetranscription.go
- voicev1.go
Click to show internal directories.
Click to hide internal directories.