Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetAntiPatterns ¶
func GetAntiPatterns() []string
GetAntiPatterns returns common mistakes agents should avoid.
func GetBestPractices ¶
func GetBestPractices() []string
GetBestPractices returns agent-specific best practices.
func GetGuideSection ¶
GetGuideSection returns a specific domain section from the guide. Returns the full guide if the domain is not found.
func GetQuerySyntax ¶
GetQuerySyntax returns query syntax documentation for each domain.
Types ¶
type CommandInfo ¶
type CommandInfo struct {
Name string `json:"name"`
FullPath string `json:"full_path"`
Description string `json:"description"`
Flags []FlagInfo `json:"flags,omitempty"`
Examples []string `json:"examples,omitempty"`
ReadOnly bool `json:"read_only"`
Subcommands []CommandInfo `json:"subcommands,omitempty"`
}
CommandInfo describes a command or subcommand.
type CompactCommand ¶
type CompactCommand struct {
Name string `json:"name"`
Flags []string `json:"flags,omitempty"`
Subcommands []CompactCommand `json:"subcommands,omitempty"`
}
CompactCommand is a minimal command representation.
type CompactSchema ¶
type CompactSchema struct {
Version string `json:"version"`
Commands []CompactCommand `json:"commands"`
}
CompactSchema is a minimal schema with just command names and flags.
func GenerateCompactSchema ¶
func GenerateCompactSchema(root *cobra.Command) CompactSchema
GenerateCompactSchema builds a token-efficient schema.
type FlagInfo ¶
type FlagInfo struct {
Name string `json:"name"`
Type string `json:"type"`
Default string `json:"default,omitempty"`
Description string `json:"description"`
}
FlagInfo describes a command flag.
type Schema ¶
type Schema struct {
Version string `json:"version"`
Description string `json:"description"`
Auth AuthInfo `json:"auth"`
GlobalFlags []FlagInfo `json:"global_flags"`
Commands []CommandInfo `json:"commands"`
QuerySyntax map[string]string `json:"query_syntax"`
TimeFormats TimeFormats `json:"time_formats"`
Workflows []Workflow `json:"workflows"`
BestPractices []string `json:"best_practices"`
AntiPatterns []string `json:"anti_patterns"`
}
Schema is the top-level structure returned by --help in agent mode or 'pup agent schema'.
func GenerateSchema ¶
GenerateSchema builds the complete schema from a cobra command tree.
type TimeFormats ¶
type TimeFormats struct {
Relative []string `json:"relative"`
Absolute []string `json:"absolute"`
Examples []string `json:"examples"`
}
TimeFormats describes supported time format options.
func GetTimeFormats ¶
func GetTimeFormats() TimeFormats
GetTimeFormats returns documentation for supported time formats.
Source Files