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
143 lines
4.9 KiB
Go
143 lines
4.9 KiB
Go
// Package doc — create.go implements `weknora doc create --text "..."`.
|
|
// Allows creating a knowledge entry directly from inline text content without
|
|
// uploading a file or fetching a remote URL.
|
|
package doc
|
|
|
|
import (
|
|
"cmp"
|
|
"context"
|
|
"fmt"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
|
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
|
sdk "github.com/Tencent/WeKnora/client"
|
|
)
|
|
|
|
// docCreateFields enumerates the fields surfaced for `--format json` discovery
|
|
// on `doc create`.
|
|
var docCreateFields = []string{
|
|
"id", "knowledge_base_id", "tag_id", "type", "title", "description",
|
|
"source", "channel", "parse_status", "summary_status", "enable_status",
|
|
"created_at", "updated_at", "error_message",
|
|
}
|
|
|
|
// CreateOptions holds CLI flag values for `doc create`.
|
|
type CreateOptions struct {
|
|
Text string // --text (required): document text content (Markdown)
|
|
Name string // --name: document title
|
|
TagID string // --tag-id: associate with a tag
|
|
Channel string // --channel: ingestion-channel tag (default "api")
|
|
DryRun bool
|
|
}
|
|
|
|
// CreateService is the narrow SDK surface for `doc create`.
|
|
// *sdk.Client satisfies it.
|
|
type CreateService interface {
|
|
CreateManualKnowledge(
|
|
ctx context.Context,
|
|
kbID string,
|
|
req *sdk.CreateManualKnowledgeRequest,
|
|
) (*sdk.Knowledge, error)
|
|
}
|
|
|
|
// NewCmdCreate builds `weknora doc create --text "..."`.
|
|
func NewCmdCreate(f *cmdutil.Factory) *cobra.Command {
|
|
opts := &CreateOptions{}
|
|
cmd := &cobra.Command{
|
|
Use: "create",
|
|
Short: "Create a knowledge entry from inline text content",
|
|
Long: `Create a new knowledge entry by passing Markdown content directly via --text.
|
|
Useful for short snippets, agent-generated content, or structured notes that
|
|
don't require a file upload or remote URL. KB resolution follows the standard
|
|
4-level chain: --kb flag > WEKNORA_KB_ID env > .weknora/project.yaml > error.
|
|
|
|
--text <content> Document text in Markdown format (required).
|
|
--name <title> Display title stored with the entry.
|
|
--tag-id <id> Associate the new entry with a tag.
|
|
--channel <name> Override the ingestion-channel tag (default "api").`,
|
|
Example: ` weknora doc create --text "# Meeting Notes\n\nAction items: ..."
|
|
weknora doc create --text "$(cat notes.md)" --name "Sprint Notes" --kb my-kb
|
|
weknora doc create --text "API usage guide" --name "API Guide" --tag-id tag_abc`,
|
|
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())
|
|
if opts.DryRun {
|
|
// ResolveKBLocal validates the KB is set via flag / env /
|
|
// project link without an SDK call; the plan reports the
|
|
// raw --kb value (UUID or name) for agent inspection.
|
|
kbID, err := f.ResolveKBLocal(c)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if handled, err := cmdutil.HandleDryRun(c, true, cmdutil.DryRunPlan{
|
|
Action: "doc.create",
|
|
Args: map[string]any{
|
|
"text": opts.Text,
|
|
"name": opts.Name,
|
|
"kb": kbID,
|
|
},
|
|
}); handled {
|
|
return err
|
|
}
|
|
}
|
|
cli, err := f.Client()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
// Live path resolves --kb name → id via the SDK.
|
|
kbID, err := f.ResolveKB(c)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return runCreate(c.Context(), opts, fopts, cli, kbID)
|
|
},
|
|
}
|
|
cmdutil.AddKBFlag(cmd)
|
|
cmd.Flags().StringVar(&opts.Text, "text", "", "Document text content in Markdown format (required)")
|
|
cmd.Flags().StringVar(&opts.Name, "name", "", "Document title")
|
|
cmd.Flags().StringVar(&opts.TagID, "tag-id", "", "Tag id to associate with the new entry")
|
|
cmd.Flags().StringVar(&opts.Channel, "channel", "", "Ingestion-channel tag recorded server-side (default \"api\")")
|
|
_ = cmd.MarkFlagRequired("text")
|
|
cmdutil.AddFormatFlag(cmd, docCreateFields...)
|
|
cmdutil.AddDryRunFlag(cmd, &opts.DryRun)
|
|
return cmd
|
|
}
|
|
|
|
// runCreate creates a manual knowledge entry via SDK CreateManualKnowledge.
|
|
func runCreate(ctx context.Context, opts *CreateOptions, fopts *cmdutil.FormatOptions, svc CreateService, kbID string) error {
|
|
// Guard against empty text: cobra's MarkFlagRequired enforces this for
|
|
// normal CLI invocations; this check protects tests that call runCreate
|
|
// directly and any future callers that bypass cobra.
|
|
if opts.Text == "" {
|
|
return cmdutil.NewFlagError(fmt.Errorf("--text is required"))
|
|
}
|
|
req := &sdk.CreateManualKnowledgeRequest{
|
|
Title: opts.Name,
|
|
Content: opts.Text,
|
|
TagID: opts.TagID,
|
|
Channel: cmp.Or(opts.Channel, uploadChannel),
|
|
}
|
|
k, err := svc.CreateManualKnowledge(ctx, kbID, req)
|
|
if err != nil {
|
|
return cmdutil.WrapHTTP(err, "create document")
|
|
}
|
|
if fopts.WantsJSON() {
|
|
return fopts.Emit(iostreams.IO.Out, k, nil)
|
|
}
|
|
displayed := opts.Name
|
|
if displayed == "" {
|
|
displayed = k.Title
|
|
}
|
|
if displayed == "" {
|
|
displayed = k.ID
|
|
}
|
|
fmt.Fprintf(iostreams.IO.Out, "✓ Created %q (id: %s)\n", displayed, k.ID)
|
|
return nil
|
|
}
|