Documentation
¶
Overview ¶
Package checks provides diagnostic check implementations for the doctor command.
Index ¶
- type A2ACheck
- type APIKeySecurityCheck
- type AgentRegistryCheck
- type ApprovalCheck
- type ChannelCheck
- type Check
- type CompanionConnectionCheck
- type ConfigCheck
- type DatabaseCheck
- type EmbeddingCheck
- type GraphStoreCheck
- type LibrarianCheck
- type MultiAgentCheck
- type NetworkCheck
- type ObservationalMemoryCheck
- type OutputScanningCheck
- type ProvidersCheck
- type Result
- type SecurityCheck
- type Status
- type Summary
- type ToolHooksCheck
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type A2ACheck ¶
type A2ACheck struct{}
A2ACheck validates A2A protocol configuration.
type APIKeySecurityCheck ¶
type APIKeySecurityCheck struct{}
APIKeySecurityCheck validates that API keys use environment variable references rather than plaintext values.
func (*APIKeySecurityCheck) Name ¶
func (c *APIKeySecurityCheck) Name() string
Name returns the check name.
type AgentRegistryCheck ¶ added in v0.4.0
type AgentRegistryCheck struct{}
AgentRegistryCheck validates agent registry configuration.
func (*AgentRegistryCheck) Fix ¶ added in v0.4.0
Fix delegates to Run as automatic fixing is not supported.
func (*AgentRegistryCheck) Name ¶ added in v0.4.0
func (c *AgentRegistryCheck) Name() string
Name returns the check name.
type ApprovalCheck ¶ added in v0.4.0
type ApprovalCheck struct{}
ApprovalCheck validates the approval system configuration.
func (*ApprovalCheck) Fix ¶ added in v0.4.0
Fix delegates to Run as automatic fixing is not supported.
func (*ApprovalCheck) Name ¶ added in v0.4.0
func (c *ApprovalCheck) Name() string
Name returns the check name.
type ChannelCheck ¶
type ChannelCheck struct{}
ChannelCheck validates channel token configurations.
type Check ¶
type Check interface {
// Name returns the human-readable name of the check.
Name() string
// Run executes the check and returns the result.
Run(ctx context.Context, cfg *config.Config) Result
// Fix attempts to repair the issue if possible.
// Returns an updated result after the fix attempt.
Fix(ctx context.Context, cfg *config.Config) Result
}
Check is the interface that all diagnostic checks must implement.
type CompanionConnectionCheck ¶
type CompanionConnectionCheck struct{}
CompanionConnectionCheck checks if the Gateway is running and if companions are connected.
func (*CompanionConnectionCheck) Name ¶
func (c *CompanionConnectionCheck) Name() string
type ConfigCheck ¶
type ConfigCheck struct{}
ConfigCheck validates the encrypted configuration profile.
type DatabaseCheck ¶
type DatabaseCheck struct{}
DatabaseCheck validates the session database accessibility.
type EmbeddingCheck ¶
type EmbeddingCheck struct{}
EmbeddingCheck validates embedding/RAG configuration.
type GraphStoreCheck ¶
type GraphStoreCheck struct{}
GraphStoreCheck validates graph store configuration.
type LibrarianCheck ¶ added in v0.4.0
type LibrarianCheck struct{}
LibrarianCheck validates the proactive librarian configuration.
func (*LibrarianCheck) Fix ¶ added in v0.4.0
Fix delegates to Run as automatic fixing is not supported.
func (*LibrarianCheck) Name ¶ added in v0.4.0
func (c *LibrarianCheck) Name() string
Name returns the check name.
type MultiAgentCheck ¶
type MultiAgentCheck struct{}
MultiAgentCheck validates multi-agent orchestration configuration.
type NetworkCheck ¶
type NetworkCheck struct{}
NetworkCheck validates network-related configuration.
type ObservationalMemoryCheck ¶
type ObservationalMemoryCheck struct{}
ObservationalMemoryCheck validates observational memory configuration.
func (*ObservationalMemoryCheck) Name ¶
func (c *ObservationalMemoryCheck) Name() string
Name returns the check name.
type OutputScanningCheck ¶
type OutputScanningCheck struct{}
OutputScanningCheck validates output scanning and interceptor configuration.
func (*OutputScanningCheck) Name ¶
func (c *OutputScanningCheck) Name() string
Name returns the check name.
type ProvidersCheck ¶
type ProvidersCheck struct{}
ProvidersCheck validates the AI provider configurations.
type Result ¶
type Result struct {
// Name is the human-readable name of the check.
Name string `json:"name"`
// Status is the result status.
Status Status `json:"status"`
// Message is the main result message.
Message string `json:"message"`
// Details provides additional information or hints.
Details string `json:"details,omitempty"`
// Fixable indicates if this issue can be auto-repaired.
Fixable bool `json:"fixable,omitempty"`
// FixAction is a description of the fix action.
FixAction string `json:"fixAction,omitempty"`
}
Result represents the result of a single check.
type SecurityCheck ¶
type SecurityCheck struct{}
SecurityCheck checks security configuration and state
func (*SecurityCheck) Name ¶
func (c *SecurityCheck) Name() string
type Summary ¶
type Summary struct {
Results []Result `json:"results"`
Passed int `json:"passed"`
Warnings int `json:"warnings"`
Failed int `json:"failed"`
Skipped int `json:"skipped"`
}
Summary aggregates multiple check results.
func NewSummary ¶
NewSummary creates a Summary from a slice of Results.
func (Summary) HasWarnings ¶
HasWarnings returns true if any check has warnings.
type ToolHooksCheck ¶ added in v0.4.0
type ToolHooksCheck struct{}
ToolHooksCheck validates tool hooks configuration.
func (*ToolHooksCheck) Fix ¶ added in v0.4.0
Fix delegates to Run as automatic fixing is not supported.
func (*ToolHooksCheck) Name ¶ added in v0.4.0
func (c *ToolHooksCheck) Name() string
Name returns the check name.
Source Files