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
107 lines
3.6 KiB
Go
107 lines
3.6 KiB
Go
package linkcmd
|
|
|
|
import (
|
|
"fmt"
|
|
"os"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
|
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
|
"github.com/Tencent/WeKnora/cli/internal/projectlink"
|
|
)
|
|
|
|
// unlinkFields enumerates the fields surfaced for `--format json` discovery on
|
|
// `unlink`. Tracks the small unlinkResult struct.
|
|
var unlinkFields = []string{"project_link_path"}
|
|
|
|
type UnlinkOptions struct {
|
|
DryRun bool
|
|
}
|
|
|
|
// unlinkResult is the typed payload emitted under data.
|
|
type unlinkResult struct {
|
|
ProjectLinkPath string `json:"project_link_path"`
|
|
}
|
|
|
|
// NewCmdUnlink builds `weknora unlink`. Walks up from cwd so a user in
|
|
// a subdirectory of a linked project can unlink without cd-ing up first.
|
|
func NewCmdUnlink() *cobra.Command {
|
|
opts := &UnlinkOptions{}
|
|
cmd := &cobra.Command{
|
|
Use: "unlink",
|
|
Short: "Remove the directory's knowledge-base binding",
|
|
Long: `Removes the .weknora/project.yaml that ` + "`weknora link`" + ` previously
|
|
wrote, so subsequent commands no longer auto-resolve --kb from the link.
|
|
|
|
Walks up from the current directory until a link is found, mirroring the
|
|
discovery that ` + "`--kb`" + ` resolution uses; you do not need to cd to the
|
|
project root to unlink. Errors with input.invalid_argument when no link
|
|
is present anywhere in the parent chain.`,
|
|
Example: ` weknora unlink # remove the binding for this project
|
|
weknora unlink --format json # bare JSON (CI / agents)`,
|
|
Args: cobra.NoArgs,
|
|
RunE: func(c *cobra.Command, _ []string) error {
|
|
fopts, err := cmdutil.CheckFormatFlag(c)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
fopts.ResolveDefault(iostreams.IO.IsStdoutTTY())
|
|
// Pure-local validation runs before the dry-run gate so --dry-run
|
|
// rejects identically to the live path. projectlink.Discover only
|
|
// reads the filesystem (no SDK / network).
|
|
cwd, cwdErr := os.Getwd()
|
|
if cwdErr != nil {
|
|
return cmdutil.Wrapf(cmdutil.CodeLocalFileIO, cwdErr, "get cwd")
|
|
}
|
|
_, found, discErr := projectlink.Discover(cwd)
|
|
if discErr != nil {
|
|
return cmdutil.Wrapf(cmdutil.CodeLocalFileIO, discErr, "discover project link")
|
|
}
|
|
if !found {
|
|
return &cmdutil.Error{
|
|
Code: cmdutil.CodeInputInvalidArgument,
|
|
Message: fmt.Sprintf("no %s/%s found at or above %s", projectlink.DirName, projectlink.FileName, cwd),
|
|
Hint: "run `weknora link --kb <id>` first, or check you're in the right directory",
|
|
}
|
|
}
|
|
if handled, err := cmdutil.HandleDryRun(c, opts.DryRun, cmdutil.DryRunPlan{
|
|
Action: "unlink",
|
|
Args: map[string]any{},
|
|
}); handled {
|
|
return err
|
|
}
|
|
return runUnlink(opts, fopts)
|
|
},
|
|
}
|
|
cmdutil.AddFormatFlag(cmd, unlinkFields...)
|
|
cmdutil.AddDryRunFlag(cmd, &opts.DryRun)
|
|
return cmd
|
|
}
|
|
|
|
func runUnlink(opts *UnlinkOptions, fopts *cmdutil.FormatOptions) error {
|
|
cwd, err := os.Getwd()
|
|
if err != nil {
|
|
return cmdutil.Wrapf(cmdutil.CodeLocalFileIO, err, "get cwd")
|
|
}
|
|
linkPath, found, err := projectlink.Discover(cwd)
|
|
if err != nil {
|
|
return cmdutil.Wrapf(cmdutil.CodeLocalFileIO, err, "discover project link")
|
|
}
|
|
if !found {
|
|
return &cmdutil.Error{
|
|
Code: cmdutil.CodeInputInvalidArgument,
|
|
Message: fmt.Sprintf("no %s/%s found at or above %s", projectlink.DirName, projectlink.FileName, cwd),
|
|
Hint: "run `weknora link --kb <id>` first, or check you're in the right directory",
|
|
}
|
|
}
|
|
if err := projectlink.Remove(linkPath); err != nil {
|
|
return cmdutil.Wrapf(cmdutil.CodeLocalFileIO, err, "remove %s", linkPath)
|
|
}
|
|
if fopts.WantsJSON() {
|
|
return fopts.Emit(iostreams.IO.Out, unlinkResult{ProjectLinkPath: linkPath}, nil)
|
|
}
|
|
fmt.Fprintf(iostreams.IO.Out, "✓ Unlinked %s\n", linkPath)
|
|
return nil
|
|
}
|