cli

package
v0.35.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 16, 2026 License: MIT Imports: 39 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Execute

func Execute() error

func GetRootCmd added in v0.3.0

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 SearchResultCompactJSON added in v0.10.0

type SearchResultCompactJSON struct {
	FilePath    string  `json:"file_path"`
	StartLine   int     `json:"start_line"`
	EndLine     int     `json:"end_line"`
	Score       float32 `json:"score"`
	FeaturePath string  `json:"feature_path,omitempty"`
	SymbolName  string  `json:"symbol_name,omitempty"`
}

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

type SearchResultJSON added in v0.6.0

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"`
	FeaturePath string  `json:"feature_path,omitempty"`
	SymbolName  string  `json:"symbol_name,omitempty"`
}

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

type WorkspaceFileConfig added in v0.27.0

type WorkspaceFileConfig struct {
	Store    config.StoreConfig    `yaml:"store" json:"store"`
	Embedder config.EmbedderConfig `yaml:"embedder" json:"embedder"`
}

WorkspaceFileConfig is the struct for --from file input.

Jump to

Keyboard shortcuts

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