6d8c8650cd
Two intertwined agent safety nets that share the same files:
1. --dry-run flag for offline preview of mutation commands
2. Risk: metadata + SetRisk helper for destructive command surfaces
Coverage (19 mutation commands with --dry-run):
kb.create/edit/delete agent.create/edit/delete
doc.create/upload/fetch/delete doc.delete_all (special variant)
session.delete chunk.delete profile.add/remove
auth.refresh/logout link unlink
api.{post,put,patch,delete} (api.get + --dry-run rejected, exit 2)
Envelope additions (omitempty in non-dry-run paths):
meta.dry_run: bool true when --dry-run was used
meta.plan: map {action, args} per the per-command taxonomy
Risk: metadata
--------------
cmdutil.SetRisk(cmd, action) stamps cobra.Annotations with
risk.level=destructive + risk.action=<action> on the 9 destructive
commands. The SetAgentHelp wrapper prepends a "Risk: <action>
(destructive)" line in the default text help path so agents see a clear
warning before parsing Usage. WEKNORA_AGENT_HELP=1 JSON path stays
unchanged — structured agent-help already carries warnings[].
Validation parity with the live path
------------------------------------
Every pure-local validation (flag presence, mutual exclusion, enum
bounds, URL/regex format, ResolveKBLocal for KB resolution that does not
require an SDK call) runs BEFORE the dry-run gate. This matches the
industry-standard "preview shows what live would do" contract:
--dry-run accepts exactly the same invocations the live path accepts and
rejects exactly the same invocations the live path rejects, modulo the
side-effecting work itself.
The side-effecting work (SDK calls, file writes, keyring writes, server-
side name → id resolution) is what --dry-run actually gates. Each
mutation file pairs its RunE validation block with a regression test
under *_dry_run_test.go / dryrun_validation_test.go so future refactors
don't reintroduce the gap.
Helper surface
--------------
- HandleDryRun(cmd, dryRun, plan) extracts the early-return so the
19 RunE call sites stay 3 lines each.
- EmitDryRun routes through FormatOptions.Emit, inheriting _notice /
TTY indent / --jq filtering for free.
- ResolveKBLocal mirrors ResolveKB but never calls the SDK; dry-run
paths use it so the plan reports the raw --kb value (UUID or name)
without a name → id lookup.
Streaming commands (chat, session ask, session continue-stream) are
deliberately excluded: a buffered plan makes no sense for an event
stream.
Lock semantics in the dry-run path:
- destructive + --dry-run: exit 0, no exit-10 confirmation prompt
- --dry-run + -y: byte-identical envelope to --dry-run alone
- --dry-run + --jq: filter applies to the preview envelope normally
111 lines
3.7 KiB
Go
111 lines
3.7 KiB
Go
package kb
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
|
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
|
"github.com/Tencent/WeKnora/cli/internal/prompt"
|
|
)
|
|
|
|
// kbDeleteFields enumerates the fields surfaced for `--format json` discovery
|
|
// on `kb delete`. The result payload is a small {id, deleted} object.
|
|
var kbDeleteFields = []string{"id", "deleted"}
|
|
|
|
type DeleteOptions struct {
|
|
Yes bool // sourced from the global -y/--yes persistent flag (see cli/cmd/root.go addGlobalFlags)
|
|
DryRun bool
|
|
}
|
|
|
|
// DeleteService is the narrow SDK surface this command depends on.
|
|
// *sdk.Client satisfies it.
|
|
type DeleteService interface {
|
|
DeleteKnowledgeBase(ctx context.Context, id string) error
|
|
}
|
|
|
|
// deleteResult is the typed payload emitted under data on success.
|
|
type deleteResult struct {
|
|
ID string `json:"id"`
|
|
Deleted bool `json:"deleted"`
|
|
}
|
|
|
|
// NewCmdDelete builds `weknora kb delete`. The global -y/--yes persistent
|
|
// flag is the single skip-prompt switch for the destructive-write
|
|
// confirmation pattern.
|
|
func NewCmdDelete(f *cmdutil.Factory) *cobra.Command {
|
|
opts := &DeleteOptions{}
|
|
cmd := &cobra.Command{
|
|
Use: "delete <kb-id>",
|
|
Short: "Delete a knowledge base",
|
|
Long: `Permanently deletes a knowledge base and all its contents.
|
|
|
|
Prompts for confirmation by default when stdout is a TTY and JSON output is not set.
|
|
Pass -y/--yes (global flag) to skip the prompt (required in agent / CI / piped contexts).
|
|
|
|
AI agents: This is a high-risk write. Without -y/--yes the CLI exits 10
|
|
and writes input.confirmation_required to stderr. NEVER auto-pass -y
|
|
without the user's explicit go-ahead — the exit-10 protocol exists
|
|
exactly to guard against unintended deletes.`,
|
|
Example: ` weknora kb delete kb_abc # interactive confirm
|
|
weknora kb delete kb_abc -y # no prompt
|
|
weknora kb delete kb_abc -y --format json # bare {id, deleted:true} JSON`,
|
|
Args: cobra.ExactArgs(1),
|
|
RunE: func(c *cobra.Command, args []string) error {
|
|
fopts, err := cmdutil.CheckFormatFlag(c)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
fopts.ResolveDefault(iostreams.IO.IsStdoutTTY())
|
|
opts.Yes, _ = c.Flags().GetBool("yes")
|
|
if handled, err := cmdutil.HandleDryRun(c, opts.DryRun, cmdutil.DryRunPlan{
|
|
Action: "kb.delete",
|
|
Args: map[string]any{
|
|
"kb_ids": args,
|
|
},
|
|
}); handled {
|
|
return err
|
|
}
|
|
cli, err := f.Client()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return runDelete(c.Context(), opts, fopts, cli, f.Prompter(), args[0])
|
|
},
|
|
}
|
|
cmdutil.AddFormatFlag(cmd, kbDeleteFields...)
|
|
cmdutil.AddDryRunFlag(cmd, &opts.DryRun)
|
|
cmdutil.SetRisk(cmd, "kb.delete")
|
|
cmdutil.SetAgentHelp(cmd, cmdutil.AgentHelp{
|
|
UsedFor: "permanently delete a knowledge base and all its contents",
|
|
RequiredFlags: []string{"<kb-id> (positional)"},
|
|
Examples: []string{
|
|
"weknora kb delete kb_abc -y",
|
|
"weknora kb delete kb_abc -y --format json",
|
|
},
|
|
Warnings: []string{
|
|
"Requires explicit user approval (exit 10 / input.confirmation_required); never auto-add -y.",
|
|
"kb delete is irreversible; whole KB + docs + chunks gone.",
|
|
},
|
|
})
|
|
return cmd
|
|
}
|
|
|
|
func runDelete(ctx context.Context, opts *DeleteOptions, fopts *cmdutil.FormatOptions, svc DeleteService, p prompt.Prompter, id string) error {
|
|
if err := cmdutil.ConfirmDestructive(p, opts.Yes, fopts.WantsJSON(), "knowledge base", id, "kb.delete", "weknora kb delete "+id+" -y"); err != nil {
|
|
return err
|
|
}
|
|
|
|
if err := svc.DeleteKnowledgeBase(ctx, id); err != nil {
|
|
return cmdutil.WrapHTTP(err, "delete knowledge base %s", id)
|
|
}
|
|
|
|
if fopts.WantsJSON() {
|
|
return fopts.Emit(iostreams.IO.Out, deleteResult{ID: id, Deleted: true}, nil)
|
|
}
|
|
fmt.Fprintf(iostreams.IO.Out, "✓ Deleted knowledge base %s\n", id)
|
|
return nil
|
|
}
|