WeKnora/cli/cmd/doc/doc.go

36 lines
1.2 KiB
Go
Raw Normal View History

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.
2026-05-13 08:40:43 +00:00
// Package doc implements the `weknora doc` subtree (list / view / upload /
refactor(cli): command-surface rename — session ask / doc fetch / doc create / doc delete --all Three command renames consolidate the v0.7 verb table: - `weknora agent invoke` → `weknora session ask --agent <id>`. Server route POST /sessions/{session_id}/agent-qa is session- anchored, so the verb moves with it. `weknora agent` subtree keeps CRUD only (list / view / create / edit / delete / status / check). SDK call (AgentQAStreamWithRequest) preserved verbatim; only the command surface + flag layout move. - `weknora doc upload` split into three commands: - `weknora doc upload <file>` — local file (only). - `weknora doc fetch <url>` — server-side remote fetch (was `upload --from-url`). URL-only flags (--title / --file-type / --tag-id) move with the verb. - `weknora doc create --text` — direct text knowledge entry via server CreateManualKnowledge. - `weknora kb empty <id>` → `weknora doc delete --all --kb=<id>`. Atomic server ClearKnowledgeBaseContents (no list-then-delete race). Same exit-10 -y/--yes guard as other destructive verbs; unified through the extended ConfirmDestructive helper. Parent commands (agent, kb, doc, chunk, session, auth, profile, search) lose their explicit Args:NoArgs + Run:cmd.Help so the unknown-subcommand guard fires correctly — `weknora agent invoke ag_x q` now emits the typed input.unknown_subcommand envelope with detail.available[] instead of cobra's free-form exit-2 prose. Spec: docs/superpowers/specs/2026-05-20-weknora-cli-v0.7-design.md §3.4 / §10.7
2026-05-21 10:42:27 +00:00
// fetch / create / download / delete / wait). Upload supports --recursive /
// --glob for bulk ingestion from local files. Fetch ingests a remote URL.
// Create adds a knowledge entry from inline text content.
//
// "Doc" is the CLI noun; the underlying SDK type is `Knowledge`. The renaming
// is deliberate: end-users think of a knowledge entry as the document they
// uploaded, not as an abstract knowledge unit. Mapping happens in this package
// only - the SDK surface and server API keep the original spelling.
package doc
import (
"github.com/spf13/cobra"
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
)
// NewCmd builds the `weknora doc` parent command.
func NewCmd(f *cmdutil.Factory) *cobra.Command {
cmd := &cobra.Command{
Use: "doc",
Short: "Manage documents in a knowledge base",
}
refactor(cli): command-surface rename — session ask / doc fetch / doc create / doc delete --all Three command renames consolidate the v0.7 verb table: - `weknora agent invoke` → `weknora session ask --agent <id>`. Server route POST /sessions/{session_id}/agent-qa is session- anchored, so the verb moves with it. `weknora agent` subtree keeps CRUD only (list / view / create / edit / delete / status / check). SDK call (AgentQAStreamWithRequest) preserved verbatim; only the command surface + flag layout move. - `weknora doc upload` split into three commands: - `weknora doc upload <file>` — local file (only). - `weknora doc fetch <url>` — server-side remote fetch (was `upload --from-url`). URL-only flags (--title / --file-type / --tag-id) move with the verb. - `weknora doc create --text` — direct text knowledge entry via server CreateManualKnowledge. - `weknora kb empty <id>` → `weknora doc delete --all --kb=<id>`. Atomic server ClearKnowledgeBaseContents (no list-then-delete race). Same exit-10 -y/--yes guard as other destructive verbs; unified through the extended ConfirmDestructive helper. Parent commands (agent, kb, doc, chunk, session, auth, profile, search) lose their explicit Args:NoArgs + Run:cmd.Help so the unknown-subcommand guard fires correctly — `weknora agent invoke ag_x q` now emits the typed input.unknown_subcommand envelope with detail.available[] instead of cobra's free-form exit-2 prose. Spec: docs/superpowers/specs/2026-05-20-weknora-cli-v0.7-design.md §3.4 / §10.7
2026-05-21 10:42:27 +00:00
cmd.AddCommand(NewCmdCreate(f))
cmd.AddCommand(NewCmdDelete(f))
cmd.AddCommand(NewCmdDownload(f))
cmd.AddCommand(NewCmdFetch(f))
cmd.AddCommand(NewCmdList(f))
cmd.AddCommand(NewCmdReparse(f))
cmd.AddCommand(NewCmdUpdate(f))
cmd.AddCommand(NewCmdUpload(f))
refactor(cli): command-surface rename — session ask / doc fetch / doc create / doc delete --all Three command renames consolidate the v0.7 verb table: - `weknora agent invoke` → `weknora session ask --agent <id>`. Server route POST /sessions/{session_id}/agent-qa is session- anchored, so the verb moves with it. `weknora agent` subtree keeps CRUD only (list / view / create / edit / delete / status / check). SDK call (AgentQAStreamWithRequest) preserved verbatim; only the command surface + flag layout move. - `weknora doc upload` split into three commands: - `weknora doc upload <file>` — local file (only). - `weknora doc fetch <url>` — server-side remote fetch (was `upload --from-url`). URL-only flags (--title / --file-type / --tag-id) move with the verb. - `weknora doc create --text` — direct text knowledge entry via server CreateManualKnowledge. - `weknora kb empty <id>` → `weknora doc delete --all --kb=<id>`. Atomic server ClearKnowledgeBaseContents (no list-then-delete race). Same exit-10 -y/--yes guard as other destructive verbs; unified through the extended ConfirmDestructive helper. Parent commands (agent, kb, doc, chunk, session, auth, profile, search) lose their explicit Args:NoArgs + Run:cmd.Help so the unknown-subcommand guard fires correctly — `weknora agent invoke ag_x q` now emits the typed input.unknown_subcommand envelope with detail.available[] instead of cobra's free-form exit-2 prose. Spec: docs/superpowers/specs/2026-05-20-weknora-cli-v0.7-design.md §3.4 / §10.7
2026-05-21 10:42:27 +00:00
cmd.AddCommand(NewCmdView(f))
cmd.AddCommand(NewCmdWait(f))
return cmd
}