index

package

v0.7.0-alpha.7 Latest Latest Go to latest Published: Jan 5, 2026 License: MIT Imports: 16 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/contextvibes/cli

Links

Open Source Insights

Documentation ¶

Overview ¶

Package index provides the command to index project documentation.

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ErrSkipDocument is returned when a document should be skipped during indexing.
	ErrSkipDocument = errors.New("skip document")
)

Functions ¶

func NewIndexCmd ¶

func NewIndexCmd() *cobra.Command

NewIndexCmd creates and configures the `index` command.

Types ¶

type DocumentMetadata ¶

type DocumentMetadata struct {
	ID                string   `json:"id"`
	FileExtension     string   `json:"fileExtension"`
	Title             string   `json:"title"`
	ArtifactVersion   string   `json:"artifactVersion,omitempty"`
	Summary           string   `json:"summary,omitempty"`
	UsageGuidance     []string `json:"usageGuidance,omitempty"`
	Owner             string   `json:"owner,omitempty"`
	CreatedDate       string   `json:"createdDate,omitempty"`
	LastModifiedDate  string   `json:"lastModifiedDate,omitempty"`
	DefaultTargetPath string   `json:"defaultTargetPath,omitempty"`
	Tags              []string `json:"tags,omitempty"`
	SourceFilePath    string   `json:"sourceFilePath"`
}

DocumentMetadata represents the metadata extracted from a document.

Source Files ¶

View all Source files

index.go

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