murli

package module

Go to main page

Versions in this module

v1

v1.0.2

May 29, 2026

v1.0.1

May 28, 2026

v1.0.0

May 28, 2026

Changes in this version

+ func FormatAgentsMD(out DescribeOutput) string

+ func WriteDoctorTTY(w io.Writer, report DoctorReport)

+ type CheckResult struct

+ Message string

+ Name string

+ Status string

+ type DoctorReport struct

+ Checks []CheckResult

+ Failed int

+ Passed int

+ Warnings int

+ func RunDoctor(out DescribeOutput) DoctorReport

v0

v0.5.0

May 27, 2026

Changes in this version

+ func ProfilePath(toolName string) string

type Capabilities

+ Profiles bool

type DescribeOutput

+ Profiles *ProfilesInfo

type FlagAnnotation

+ Profileable bool

type FlagSchema

+ Profileable bool

+ type Profile struct

+ Flags map[string]string

+ type ProfileStore struct

+ Default string

+ Profiles map[string]Profile

+ func LoadProfileStore(toolName string) (*ProfileStore, error)

+ func (s *ProfileStore) Delete(name string)

+ func (s *ProfileStore) Get(name string) (Profile, bool)

+ func (s *ProfileStore) Names() []string

+ func (s *ProfileStore) Save(toolName string) error

+ func (s *ProfileStore) Set(name string, p Profile)

+ func (s *ProfileStore) SetDefault(name string) error

+ type ProfilesInfo struct

+ Available []string

+ Default string

+ ProfileableFlags []string

v0.4.0

May 27, 2026

Changes in this version

type CommandSchema

+ Safety SafetyBlock

type DescribeCommandSchema

+ Safety SafetyBlock

type Metadata

+ Destructive bool

+ DryRunnable bool

+ Reversible bool

+ type SafetyBlock struct

+ Destructive bool

+ DryRunnable bool

+ Idempotent bool

+ ReadOnly bool

+ Reversible bool

type Writer

+ func (w *Writer) IsDryRun() bool

+ func (w *Writer) IsForced() bool

+ func (w *Writer) WritePlan(humanText string, plan any)

type WriterOption

+ func WithDryRun(dryRun bool) WriterOption

+ func WithForce(force bool) WriterOption

v0.3.0

May 26, 2026

Changes in this version

+ var ValidOutputFormats = []string

+ var ValidProtocolVersions = []string

+ func ApplyFlagAnnotation(fs *FlagSchema, ann FlagAnnotation)

+ func CheckConventions(commandNames, flagNames []string, w io.Writer) int

+ type Capabilities struct

+ DryRun bool

+ OutputFormats []string

+ ProtocolVersion string

+ SchemaVersion string

+ Streaming bool

+ ToolVersion string

+ func DefaultCapabilities() Capabilities

type CommandSchema

+ Mutating bool

+ type Conventions struct

+ Vocabulary map[string]string

+ func ConventionalVocabulary() *Conventions

+ type DescribeCommandSchema struct

+ AgentDescription string

+ Arguments []ArgumentMetadata

+ Examples []Example

+ Flags []FlagSchema

+ Idempotent bool

+ Mutating bool

+ Name string

+ Returns *ReturnSchema

+ Subcommands []DescribeCommandSchema

+ Summary string

+ WhenToUse string

+ type DescribeOutput struct

+ Capabilities Capabilities

+ Commands []DescribeCommandSchema

+ Conventions *Conventions

+ Name string

+ SchemaVersion string

+ Summary string

+ ToolVersion string

+ type Example struct

+ Command string

+ Description string

+ ExpectedExitCode int

+ type FlagAnnotation struct

+ Enum []string

+ Env string

+ MutuallyExclusiveWith []string

+ Pattern string

+ Persistent bool

+ Sensitive bool

type FlagSchema

+ Enum []string

+ Env string

+ MutuallyExclusiveWith []string

+ Pattern string

+ Persistent bool

+ Sensitive bool

type Metadata

+ FlagAnnotations map[string]FlagAnnotation

+ type OutputFormat string

+ const OutputFormatDefault

+ const OutputFormatJSON

+ const OutputFormatNDJSON

+ const OutputFormatText

+ const OutputFormatYAML

type ReturnSchema

+ OutputSchema json.RawMessage

type Writer

+ func (w *Writer) Format() OutputFormat

+ func (w *Writer) ProtocolVersion() string

+ type WriterOption func(*Writer)

+ func WithOutputFormat(f OutputFormat) WriterOption

+ func WithProtocolVersion(v string) WriterOption

v0.2.0

May 26, 2026

Changes in this version

+ const ExitCancelled

+ const ExitConflict

+ const ExitNotFound

+ const ExitOK

+ const ExitPartial

+ const ExitPermission

+ const ExitRateLimited

+ const ExitTimeout

+ const ExitToolError

+ const ExitUserError

+ const SchemaVersion

+ var ExitFunc = os.Exit

+ var ToolVersion = ""

+ type AgentError struct

+ Code int

+ DocURL string

+ ErrorType string

+ Field string

+ Message string

+ Recoverable bool

+ RetryAfterMs int

+ SchemaVersion string

+ Suggestion string

+ ToolVersion string

+ ValidValues []string

+ func NewToolError(message string) *AgentError

+ func NewUserError(message, suggestion string) *AgentError

+ func (e *AgentError) Error() string

+ type ArgumentMetadata struct

+ Description string

+ Name string

+ Required bool

+ Type string

+ type CommandSchema struct

+ AgentDescription string

+ Arguments []ArgumentMetadata

+ Examples []string

+ Flags []FlagSchema

+ Idempotent bool

+ Name string

+ Returns *ReturnSchema

+ Subcommands []SubcommandSchema

+ Summary string

+ WhenToUse string

+ type FlagSchema struct

+ Default any

+ Description string

+ Name string

+ Type string

+ type Logger struct

+ func NewLogger(writer io.Writer, isTTY bool) *Logger

+ func (l *Logger) Flush()

+ func (l *Logger) Log(line string)

+ func (l *Logger) LogProgress(line string)

+ type Metadata struct

+ AgentDescription string

+ Arguments []ArgumentMetadata

+ Examples []string

+ Idempotent bool

+ Mutating bool

+ Returns *ReturnSchema

+ WhenToUse string

+ type ProgressEvent struct

+ Current int

+ EtaMs int64

+ Message string

+ Percent float64

+ Stage string

+ Total int

+ type ReturnSchema struct

+ Description string

+ Shape map[string]any

+ Type string

+ type SubcommandSchema struct

+ Name string

+ Summary string

+ type Writer struct

+ func NewWriter(stdout, stderr io.Writer, agentMode bool) *Writer

+ func (w *Writer) Flush()

+ func (w *Writer) IsTTY() bool

+ func (w *Writer) Log(msg string)

+ func (w *Writer) Progress(msg string)

+ func (w *Writer) WriteError(err *AgentError)

+ func (w *Writer) WriteEvent(v any)

+ func (w *Writer) WriteProgress(evt ProgressEvent)

+ func (w *Writer) WriteSuccess(humanText string, jsonPayload any)

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