cmd

package

v0.2.0 Latest Latest Go to latest Published: Jun 8, 2025 License: MIT Imports: 27 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 ¶

cmd/codemod.go

cmd/deploy.go

cmd/describe.go

cmd/format.go

cmd/index.go

cmd/kickoff.go

cmd/plan.go

cmd/test.go

cmd/thea.go

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	AppLogger       *slog.Logger
	LoadedAppConfig *config.Config
	ExecClient      *exec.ExecutorClient // For general command execution

	AppVersion string // Set in init() or by ldflags
)

These are package-level variables, intended to be accessible by all files within this 'cmd' package.

Functions ¶

func Execute ¶

func Execute()

Execute is the main entry point for the CLI. It's made public so main.go can call it.

Types ¶

type DocumentMetadata ¶ added in v0.2.0

type DocumentMetadata struct {
	ID                string   `json:"id"`                          // e.g., "category/path/artifact-name" (derived: relative path w/o ext)
	FileExtension     string   `json:"fileExtension"`               // e.g., "md", "yml" (derived from source file)
	Title             string   `json:"title"`                       // From front matter
	ArtifactVersion   string   `json:"artifactVersion,omitempty"`   // From front matter (semver)
	Summary           string   `json:"summary,omitempty"`           // From front matter
	UsageGuidance     []string `json:"usageGuidance,omitempty"`     // From front matter (can be a list)
	Owner             string   `json:"owner,omitempty"`             // From front matter (role/nickname)
	CreatedDate       string   `json:"createdDate,omitempty"`       // From front matter (ISO 8601)
	LastModifiedDate  string   `json:"lastModifiedDate,omitempty"`  // From front matter (ISO 8601) or file mod time
	DefaultTargetPath string   `json:"defaultTargetPath,omitempty"` // From front matter, or derived (id + fileExtension)
	Tags              []string `json:"tags,omitempty"`              // From front matter
	SourceFilePath    string   `json:"sourceFilePath"`              // Relative path of the source file processed (baseDirName/relPath)
}

DocumentMetadata holds the parsed front matter and derived info from a file. This struct will be marshalled to JSON for the output of 'contextvibes index'.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
contextvibes

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