cli

Documentation

Index

• func Execute() error
• func GenerateAgentConfigs(cwd string) error
• func GetRootCmd() *cobra.Command
• func SearchJSON(projectRoot string, query string, limit int) ([]store.SearchResult, error)
• func SetVersion(v string)
• type AgentConfig
  • func SupportedAgentConfigs() []AgentConfig
• type AgentFile
• type ClaudeSettings
• type FileResultCompactJSON
• type FileResultJSON
• type HookAction
• type SearchResultCompactJSON
• type SearchResultJSON
• type SettingsHooks
• type ToolHook

Functions

func Execute

func Execute() error

func GenerateAgentConfigs

func GenerateAgentConfigs(cwd string) error

GenerateAgentConfigs creates configuration files for all supported coding agents

func GetRootCmd

func GetRootCmd() *cobra.Command

GetRootCmd returns the root command for documentation generation

func SearchJSON

func SearchJSON(projectRoot string, query string, limit int) ([]store.SearchResult, error)

SearchJSON returns results in JSON format for AI agents

func SetVersion

func SetVersion(v string)

Types

type AgentConfig

type AgentConfig struct {
	Name        string
	Description string
	Files       []AgentFile
	Directories []string
}

AgentConfig represents a coding agent configuration

func SupportedAgentConfigs

func SupportedAgentConfigs() []AgentConfig

SupportedAgentConfigs returns all supported coding agent configurations

type AgentFile

type AgentFile struct {
	TemplateName string // Name in embedded templates
	DestPath     string // Destination path relative to project root
	Description  string // Human-readable description
}

AgentFile represents a file to be generated for an agent

type ClaudeSettings

type ClaudeSettings struct {
	EnabledPlugins map[string]bool `json:"enabledPlugins,omitempty"`
	Hooks          *SettingsHooks  `json:"hooks,omitempty"`
}

ClaudeSettings represents the .claude/settings.json structure

type FileResultCompactJSON

type FileResultCompactJSON struct {
	Path string `json:"path"`
}

FileResultCompactJSON is the minimal output struct for compact mode

type FileResultJSON

type FileResultJSON struct {
	Path    string `json:"path"`
	ModTime string `json:"mod_time"`
}

FileResultJSON is the full output struct for JSON mode

type HookAction

type HookAction struct {
	Type    string `json:"type"`
	Command string `json:"command"`
}

HookAction represents an action within a hook

type SearchResultCompactJSON

type SearchResultCompactJSON struct {
	FilePath  string  `json:"file_path"`
	StartLine int     `json:"start_line"`
	EndLine   int     `json:"end_line"`
	Score     float32 `json:"score"`
}

SearchResultCompactJSON is a minimal struct for compact JSON output (no content field)

type SearchResultJSON

type SearchResultJSON struct {
	FilePath  string  `json:"file_path"`
	StartLine int     `json:"start_line"`
	EndLine   int     `json:"end_line"`
	Score     float32 `json:"score"`
	Content   string  `json:"content"`
}

SearchResultJSON is a lightweight struct for JSON output (excludes vector, hash, updated_at)

type SettingsHooks

type SettingsHooks struct {
	UserPromptSubmit []ToolHook `json:"UserPromptSubmit,omitempty"`
	PreToolUse       []ToolHook `json:"PreToolUse,omitempty"`
	PostToolUse      []ToolHook `json:"PostToolUse,omitempty"`
	Stop             []ToolHook `json:"Stop,omitempty"`
}

SettingsHooks contains hook configurations

type ToolHook

type ToolHook struct {
	Matcher string       `json:"matcher"`
	Hooks   []HookAction `json:"hooks"`
}

ToolHook represents a single tool hook configuration