feat(cli): doc view + unlink (fill v0.3 design-gap audit)
Final design-pass audit on the v0.3 surface flagged two real gaps. (A) doc view <id> was missing. Every other resource subtree exposes a view verb (kb view, session view) for inspecting a single record, but doc — which has the richest metadata of the three (title, file name, type, size, parse_status, embedding_model, processed_at, error_message) — had no single-doc surface. Users wanting one doc's metadata had to `doc list | grep`. Implementation mirrors kb view: narrow ViewService(GetKnowledge) interface, --json envelope path, human KEY: VALUE renderer. Optional fields are omitted rather than rendered as "-" so the panel is dense. Tested: human renderer, title fallback when FileName empty, omit-empty contract, JSON envelope shape, 404 classification. (B) link had no counterpart. Once .weknora/project.yaml is written, the only way to clear it was `rm` by hand. Both vercel and netlify ship `unlink` as a top-level verb; not having one was a discoverability gap. Top-level rather than `link --clear` follows the verb-noun convention of the rest of the surface — the verb stands alone and the operation isn't parameterised. unlink walks up from cwd via projectlink.Discover (the same parent-chain logic Factory.ResolveKB uses on the read side), so a user in a subdirectory of a linked project can unlink without cd-ing up. Errors with input.invalid_argument when no link is found anywhere in the chain. Idempotent under racy concurrent removal: os.ErrNotExist on os.Remove falls through to a Success envelope since the post-condition holds either way. projectlink package gained Remove() alongside Save / Load / Discover so unlink doesn't reimplement the idempotent-remove pattern inline. Top-level registration in cmd/root.go, alongside link. cli/AGENTS.md verb canon line adds unlink to the locally-introduced list. cli/CHANGELOG.md gains an Added entry for each. 5 unit tests for view + 4 for unlink (cwd / walk-up / no-link error / JSON envelope). Full suite green. Intentionally deferred: - session edit (rename a session): sessions auto-name from the first prompt; polish rather than a gap. - link --clear as an alternative to unlink: top-level unlink is the documented form; aliases would just multiply the surface.
This commit is contained in:
@@ -0,0 +1,76 @@
|
||||
package linkcmd
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
|
||||
"github.com/Tencent/WeKnora/cli/internal/agent"
|
||||
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
||||
"github.com/Tencent/WeKnora/cli/internal/format"
|
||||
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
||||
"github.com/Tencent/WeKnora/cli/internal/projectlink"
|
||||
)
|
||||
|
||||
type UnlinkOptions struct {
|
||||
JSONOut 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 --json # envelope output (CI / agents)`,
|
||||
Args: cobra.NoArgs,
|
||||
RunE: func(c *cobra.Command, _ []string) error {
|
||||
return runUnlink(opts)
|
||||
},
|
||||
}
|
||||
cmd.Flags().BoolVar(&opts.JSONOut, "json", false, "Output JSON envelope")
|
||||
agent.SetAgentHelp(cmd, "Removes .weknora/project.yaml (the cwd → KB binding). Walks up from cwd. Errors with input.invalid_argument when no link is present in the parent chain.")
|
||||
return cmd
|
||||
}
|
||||
|
||||
func runUnlink(opts *UnlinkOptions) 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 opts.JSONOut {
|
||||
return format.WriteEnvelope(iostreams.IO.Out, format.Success(
|
||||
unlinkResult{ProjectLinkPath: linkPath}, nil))
|
||||
}
|
||||
fmt.Fprintf(iostreams.IO.Out, "✓ Unlinked %s\n", linkPath)
|
||||
return nil
|
||||
}
|
||||
Reference in New Issue
Block a user