Documentation
¶
Overview ¶
Package agent provides C7 agent evaluation infrastructure for headless Claude Code execution.
Index ¶
Constants ¶
const CompletenessPrompt = `` /* 762-byte string literal not displayed */
CompletenessPrompt evaluates documentation completeness. Criteria: essential sections present, API coverage, troubleshooting.
const CrossRefCoherencePrompt = `` /* 922-byte string literal not displayed */
CrossRefCoherencePrompt evaluates documentation cross-reference quality. Criteria: consistent terminology, valid internal links, coherent structure.
const ExampleQualityPrompt = `` /* 853-byte string literal not displayed */
ExampleQualityPrompt evaluates code example quality. Criteria: runnability, clarity, best practices demonstration.
const ReadmeClarityPrompt = `` /* 944-byte string literal not displayed */
ReadmeClarityPrompt evaluates README documentation clarity. Criteria: purpose clarity, quickstart quality, structure, inline examples.
Variables ¶
This section is empty.
Functions ¶
func CheckClaudeCLI ¶
func CheckClaudeCLI() error
CheckClaudeCLI verifies that the Claude CLI is installed and accessible. Returns nil if available, or a descriptive error with installation instructions.
func NewCLIExecutor ¶ added in v0.0.8
NewCLIExecutor creates a metrics.Executor that runs prompts via Claude CLI. This exported constructor allows external packages (e.g. c7_agent) to create a live CLI executor without depending on unexported agent internals.
Types ¶
type CLIStatus ¶
type CLIStatus struct {
Available bool // whether CLI is usable
Version string // CLI version string (e.g., "claude 2.1.12")
Error string // error message if not available
InstallHint string // installation instructions
}
CLIStatus represents the availability and version of the Claude CLI.
func GetCLIStatus ¶
func GetCLIStatus() CLIStatus
GetCLIStatus returns cached CLI status, detecting on first call. This is efficient for repeated checks within a single process.
type Evaluator ¶
type Evaluator struct {
// contains filtered or unexported fields
}
Evaluator performs content quality evaluation using the Claude CLI.
func NewEvaluator ¶
NewEvaluator creates an Evaluator with the specified timeout. If timeout is 0, a default of 60 seconds is used.
func (*Evaluator) EvaluateContent ¶
func (e *Evaluator) EvaluateContent(ctx context.Context, systemPrompt, content string) (evaluationResult, error)
EvaluateContent runs content evaluation using the Claude CLI. The systemPrompt provides evaluation criteria, and content is the material to evaluate.
func (*Evaluator) EvaluateWithRetry ¶
func (e *Evaluator) EvaluateWithRetry(ctx context.Context, systemPrompt, content string) (evaluationResult, error)
EvaluateWithRetry runs EvaluateContent with one retry on failure.
func (*Evaluator) SetCommandRunner ¶
func (e *Evaluator) SetCommandRunner(fn commandRunnerFunc)
SetCommandRunner replaces the command execution function (for testing).