mirror of
https://github.com/Tencent/WeKnora.git
synced 2026-08-30 16:53:21 +08:00
da9faa9e07
Borrows the lark-cli agent-affordance model (https://github.com/larksuite/cli/blob/main/AGENTS.md + skills/lark-shared/SKILL.md) so weknora is designed to be agent-friendly: error messages, output format, and flag design follow conventions agents can rely on. cli/AGENTS.md (operational reference for LLM agents invoking weknora): Public document covering envelope schema, exit-code protocol (0/1/2/10/130), stdout/stderr separation, and behavioral rules. Sensitive commands (\`context use\`, \`kb delete\`, \`doc delete\`, \`init\`) gain "AI agents:" paragraphs in their cobra Long descriptions so guidance shows in --help. format.Envelope schema additions: Risk per-operation classification (read / write / high-risk-write + action description), populated by write commands on both success and failure paths. Notice system advisories (CLI update available, server-CLI version skew); type defined, emit sites land in v0.3. DryRun marker for envelopes returned from --dry-run preview paths. RiskLevel constants realigned to lark's taxonomy: read / write / high-risk-write (was: read / mutating / destructive — not yet wired by any command). cmdutil.Error gains OperationRisk; PrintErrorEnvelope auto-attaches it to envelope.Risk so destructive failure paths surface uniformly. Exit-10 confirmation protocol: New ErrorCode \`input.confirmation_required\` mapped to exit code 10 in cmdutil.ExitCode. ConfirmDestructive now returns this code (with OperationRisk attached) when stdout is non-TTY or --json was set, with -y/--yes absent. Previous behavior — silent proceed in non-TTY — was unsafe: scripts and agents could delete resources with no explicit approval. Three test cases re-pinned around the new contract. This is a wire-contract change for any caller who relied on silent proceed; v0.0/v0.1 had no destructive commands, so the blast radius is contained to v0.2 itself. --dry-run global flag: cmd write paths (kb create/delete, doc upload/delete, api POST/PUT/PATCH/ DELETE) check cmdutil.IsDryRun(cmd) and skip the SDK call, emitting an envelope with dry_run=true plus a Risk classification. Read commands ignore --dry-run by design (no side effect to preview). Human-mode prints \`[dry-run] would <action>\` to stdout. Command discovery: agents introspect via the existing \`--help\` surface (consistent with gh / kubectl / aws / gcloud / terraform — none of them ship a CLI-tree self-description command). An earlier draft added a \`weknora schema\` reflection command; dropped after a mainstream survey found it has no stable analog (lark-cli's schema describes Lark API methods, not its own CLI tree). Tests: 27 cli packages pass at this commit. Added two new tests covering envelope.risk and envelope._notice serialization.
146 lines
3.9 KiB
Go
146 lines
3.9 KiB
Go
package contextcmd
|
|
|
|
import (
|
|
"fmt"
|
|
"sort"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/agent"
|
|
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
|
"github.com/Tencent/WeKnora/cli/internal/config"
|
|
"github.com/Tencent/WeKnora/cli/internal/format"
|
|
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
|
)
|
|
|
|
// NewCmdUse builds the `weknora context use <name>` command.
|
|
func NewCmdUse(f *cmdutil.Factory) *cobra.Command {
|
|
cmd := &cobra.Command{
|
|
Use: "use <name>",
|
|
Short: "Switch the default context for subsequent commands",
|
|
Long: `Switches the default context written in config.yaml. Names are case-sensitive.
|
|
|
|
The active context is what every subsequent command uses for auth + host. The
|
|
global --context flag (e.g. weknora --context staging kb list) overrides for
|
|
one command without writing to disk.
|
|
|
|
AI agents: Do NOT switch the active context unless the user explicitly asked
|
|
you to. Context selection is a user preference; one-shot overrides should use
|
|
the global --context flag instead, which writes nothing to disk.`,
|
|
Example: ` weknora context use staging # persist switch
|
|
weknora --context staging kb list # one-shot override (no disk write)
|
|
weknora context use --help # this help`,
|
|
Args: cobra.ExactArgs(1),
|
|
RunE: func(c *cobra.Command, args []string) error {
|
|
return runUse(args[0])
|
|
},
|
|
}
|
|
agent.SetAgentHelp(cmd, "Switches default CLI context. Returns previous_context + current_context. Errors with hint when name unknown.")
|
|
return cmd
|
|
}
|
|
|
|
type useResult struct {
|
|
CurrentContext string `json:"current_context"`
|
|
PreviousContext string `json:"previous_context,omitempty"`
|
|
}
|
|
|
|
func runUse(name string) error {
|
|
cfg, err := config.Load()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if _, ok := cfg.Contexts[name]; !ok {
|
|
return notFoundError(name, cfg)
|
|
}
|
|
prev := cfg.CurrentContext
|
|
cfg.CurrentContext = name
|
|
if err := config.Save(cfg); err != nil {
|
|
return err
|
|
}
|
|
return format.WriteEnvelope(iostreams.IO.Out, format.Success(useResult{
|
|
CurrentContext: name,
|
|
PreviousContext: prev,
|
|
}, nil))
|
|
}
|
|
|
|
func notFoundError(name string, cfg *config.Config) error {
|
|
if len(cfg.Contexts) == 0 {
|
|
return &cmdutil.Error{
|
|
Code: cmdutil.CodeLocalContextNotFound,
|
|
Message: fmt.Sprintf("context not found: %s", name),
|
|
Hint: "no contexts registered — run `weknora auth login` first",
|
|
}
|
|
}
|
|
keys := contextKeys(cfg.Contexts)
|
|
candidate := closestMatch(name, keys)
|
|
var hint string
|
|
if candidate != "" && candidate != name {
|
|
hint = fmt.Sprintf("did you mean: %q?", candidate)
|
|
} else {
|
|
hint = fmt.Sprintf("available contexts: %v", keys)
|
|
}
|
|
return &cmdutil.Error{
|
|
Code: cmdutil.CodeLocalContextNotFound,
|
|
Message: fmt.Sprintf("context not found: %s", name),
|
|
Hint: hint,
|
|
}
|
|
}
|
|
|
|
func contextKeys(m map[string]config.Context) []string {
|
|
out := make([]string, 0, len(m))
|
|
for k := range m {
|
|
out = append(out, k)
|
|
}
|
|
return out
|
|
}
|
|
|
|
// closestMatch returns the candidate with min levenshtein distance ≤ 2,
|
|
// or "" if none qualifies. Ties broken by lexicographic order so the hint
|
|
// is deterministic across map-iteration orderings (Go randomizes range over
|
|
// map; without this, did-you-mean output is flaky for equally-close
|
|
// candidates).
|
|
func closestMatch(target string, candidates []string) string {
|
|
sorted := append([]string(nil), candidates...)
|
|
sort.Strings(sorted)
|
|
best := ""
|
|
bestD := 3
|
|
for _, c := range sorted {
|
|
d := levenshtein(target, c)
|
|
if d < bestD {
|
|
bestD = d
|
|
best = c
|
|
}
|
|
}
|
|
if bestD > 2 {
|
|
return ""
|
|
}
|
|
return best
|
|
}
|
|
|
|
func levenshtein(a, b string) int {
|
|
la, lb := len(a), len(b)
|
|
if la == 0 {
|
|
return lb
|
|
}
|
|
if lb == 0 {
|
|
return la
|
|
}
|
|
prev := make([]int, lb+1)
|
|
curr := make([]int, lb+1)
|
|
for j := 0; j <= lb; j++ {
|
|
prev[j] = j
|
|
}
|
|
for i := 1; i <= la; i++ {
|
|
curr[0] = i
|
|
for j := 1; j <= lb; j++ {
|
|
cost := 1
|
|
if a[i-1] == b[j-1] {
|
|
cost = 0
|
|
}
|
|
curr[j] = min(curr[j-1]+1, prev[j]+1, prev[j-1]+cost)
|
|
}
|
|
prev, curr = curr, prev
|
|
}
|
|
return prev[lb]
|
|
}
|