feat(cli): agent-first WeKnora CLI
The `weknora` command-line client for the WeKnora RAG server. Full command surface: kb / doc / chunk / session / message / agent / model / search / chat / auth / profile / link / api / mcp / skills / config / doctor / schema / exit-codes. Agent-first wire contract: JSON envelope by default, typed error codes mapped to stable exit codes, error.retry_argv / retryable / partial-failure status, global --dry-run preview, the exit-10 confirmation protocol for writes, and control/ANSI/Bidi input hygiene. Stateless env-credential auth (WEKNORA_API_KEY / WEKNORA_TOKEN + WEKNORA_HOST) for headless/CI/agent use. A curated read-only MCP tool surface (`mcp serve`) and embedded Agent Skills (`skills install`). Extensive unit + contract-golden tests and CI.
This commit is contained in:
@@ -31,6 +31,12 @@ type AgentHelp struct {
|
||||
Warnings []string `json:"warnings,omitempty"`
|
||||
}
|
||||
|
||||
// agentHelpAnnotation stores the marshaled AgentHelp on the command so the
|
||||
// `weknora schema` command can introspect any command's contract without
|
||||
// invoking its help func (and toggling WEKNORA_AGENT_HELP). Shares the
|
||||
// annotations map with SetRisk (distinct keys).
|
||||
const agentHelpAnnotation = "weknora.agent_help"
|
||||
|
||||
// SetAgentHelp attaches agent-targeted help metadata to a command.
|
||||
//
|
||||
// Routing:
|
||||
@@ -39,7 +45,17 @@ type AgentHelp struct {
|
||||
// - Otherwise (human help path): if cmd has risk annotations from SetRisk,
|
||||
// prepend "Risk: <action> (<level>)" line; then render the normal human
|
||||
// help via origHelp; then append the "AI agents:" Warnings block.
|
||||
//
|
||||
// The AgentHelp is also recorded as a JSON annotation so `weknora schema` can
|
||||
// surface it as a first-class, discoverable command (not only via the
|
||||
// WEKNORA_AGENT_HELP env toggle on --help).
|
||||
func SetAgentHelp(cmd *cobra.Command, ah AgentHelp) {
|
||||
if b, err := json.Marshal(ah); err == nil {
|
||||
if cmd.Annotations == nil {
|
||||
cmd.Annotations = make(map[string]string)
|
||||
}
|
||||
cmd.Annotations[agentHelpAnnotation] = string(b)
|
||||
}
|
||||
origHelp := cmd.HelpFunc()
|
||||
cmd.SetHelpFunc(func(c *cobra.Command, args []string) {
|
||||
if os.Getenv("WEKNORA_AGENT_HELP") == "1" {
|
||||
@@ -64,6 +80,22 @@ func SetAgentHelp(cmd *cobra.Command, ah AgentHelp) {
|
||||
})
|
||||
}
|
||||
|
||||
// AgentHelpFor returns the AgentHelp registered on cmd via SetAgentHelp.
|
||||
// ok is false when the command carries none (e.g. cobra-generated subtrees).
|
||||
func AgentHelpFor(cmd *cobra.Command) (ah AgentHelp, ok bool) {
|
||||
if cmd.Annotations == nil {
|
||||
return ah, false
|
||||
}
|
||||
raw, present := cmd.Annotations[agentHelpAnnotation]
|
||||
if !present {
|
||||
return ah, false
|
||||
}
|
||||
if err := json.Unmarshal([]byte(raw), &ah); err != nil {
|
||||
return ah, false
|
||||
}
|
||||
return ah, true
|
||||
}
|
||||
|
||||
func emitAgentHelp(w io.Writer, ah AgentHelp) {
|
||||
enc := json.NewEncoder(w)
|
||||
enc.SetEscapeHTML(false)
|
||||
|
||||
Reference in New Issue
Block a user