da9faa9e07
Borrows the lark-cli agent-affordance model (https://github.com/larksuite/cli/blob/main/AGENTS.md + skills/lark-shared/SKILL.md) so weknora is designed to be agent-friendly: error messages, output format, and flag design follow conventions agents can rely on. cli/AGENTS.md (operational reference for LLM agents invoking weknora): Public document covering envelope schema, exit-code protocol (0/1/2/10/130), stdout/stderr separation, and behavioral rules. Sensitive commands (\`context use\`, \`kb delete\`, \`doc delete\`, \`init\`) gain "AI agents:" paragraphs in their cobra Long descriptions so guidance shows in --help. format.Envelope schema additions: Risk per-operation classification (read / write / high-risk-write + action description), populated by write commands on both success and failure paths. Notice system advisories (CLI update available, server-CLI version skew); type defined, emit sites land in v0.3. DryRun marker for envelopes returned from --dry-run preview paths. RiskLevel constants realigned to lark's taxonomy: read / write / high-risk-write (was: read / mutating / destructive — not yet wired by any command). cmdutil.Error gains OperationRisk; PrintErrorEnvelope auto-attaches it to envelope.Risk so destructive failure paths surface uniformly. Exit-10 confirmation protocol: New ErrorCode \`input.confirmation_required\` mapped to exit code 10 in cmdutil.ExitCode. ConfirmDestructive now returns this code (with OperationRisk attached) when stdout is non-TTY or --json was set, with -y/--yes absent. Previous behavior — silent proceed in non-TTY — was unsafe: scripts and agents could delete resources with no explicit approval. Three test cases re-pinned around the new contract. This is a wire-contract change for any caller who relied on silent proceed; v0.0/v0.1 had no destructive commands, so the blast radius is contained to v0.2 itself. --dry-run global flag: cmd write paths (kb create/delete, doc upload/delete, api POST/PUT/PATCH/ DELETE) check cmdutil.IsDryRun(cmd) and skip the SDK call, emitting an envelope with dry_run=true plus a Risk classification. Read commands ignore --dry-run by design (no side effect to preview). Human-mode prints \`[dry-run] would <action>\` to stdout. Command discovery: agents introspect via the existing \`--help\` surface (consistent with gh / kubectl / aws / gcloud / terraform — none of them ship a CLI-tree self-description command). An earlier draft added a \`weknora schema\` reflection command; dropped after a mainstream survey found it has no stable analog (lark-cli's schema describes Lark API methods, not its own CLI tree). Tests: 27 cli packages pass at this commit. Added two new tests covering envelope.risk and envelope._notice serialization.
138 lines
4.8 KiB
Go
138 lines
4.8 KiB
Go
package doc
|
|
|
|
import (
|
|
"context"
|
|
"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"
|
|
sdk "github.com/Tencent/WeKnora/client"
|
|
)
|
|
|
|
// uploadChannel is the ingestion-channel tag the server records for CLI uploads.
|
|
// Distinct from "web" (browser UI), "browser_extension" (one-click capture),
|
|
// and "wechat" (mini-program). The server uses this only for analytics.
|
|
const uploadChannel = "api"
|
|
|
|
// UploadOptions captures `weknora doc upload` flags.
|
|
type UploadOptions struct {
|
|
Name string
|
|
JSONOut bool
|
|
DryRun bool
|
|
}
|
|
|
|
// UploadService is the narrow SDK surface this command depends on.
|
|
// *sdk.Client satisfies it.
|
|
type UploadService interface {
|
|
CreateKnowledgeFromFile(
|
|
ctx context.Context,
|
|
kbID, filePath string,
|
|
metadata map[string]string,
|
|
enableMultimodel *bool,
|
|
customFileName, channel string,
|
|
) (*sdk.Knowledge, error)
|
|
}
|
|
|
|
// NewCmdUpload builds `weknora doc upload <file>`.
|
|
func NewCmdUpload(f *cmdutil.Factory) *cobra.Command {
|
|
opts := &UploadOptions{}
|
|
cmd := &cobra.Command{
|
|
Use: "upload <file>",
|
|
Short: "Upload a local file to the knowledge base",
|
|
Long: `Uploads a file (PDF / DOCX / Markdown / TXT / etc.) to the resolved
|
|
knowledge base. KB id resolution follows the standard 5-level chain:
|
|
--kb-id flag > --kb name > WEKNORA_KB_ID env > .weknora/project.yaml > error.
|
|
|
|
Pass --name to override the recorded file name (useful when the local file
|
|
has a generic name like "report.pdf" but you want to surface it as e.g.
|
|
"Q3 Marketing Report.pdf" in the UI).
|
|
|
|
v0.2 ships single-file upload only; --recursive / --glob and progress UI are
|
|
planned for v0.3.`,
|
|
Example: ` weknora doc upload report.pdf
|
|
weknora doc upload notes.md --kb-id kb_abc
|
|
weknora doc upload q3.pdf --name "Q3 Marketing Report.pdf"`,
|
|
Args: cobra.ExactArgs(1),
|
|
RunE: func(c *cobra.Command, args []string) error {
|
|
path := args[0]
|
|
if err := validateUploadPath(path); err != nil {
|
|
return err
|
|
}
|
|
opts.DryRun = cmdutil.IsDryRun(c)
|
|
kbID, err := f.ResolveKB(c)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if opts.DryRun {
|
|
return runUpload(c.Context(), opts, nil, kbID, path)
|
|
}
|
|
cli, err := f.Client()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return runUpload(c.Context(), opts, cli, kbID, path)
|
|
},
|
|
}
|
|
cmd.Flags().String("kb-id", "", "Knowledge base id (overrides env / project link)")
|
|
cmd.Flags().String("kb", "", "Knowledge base name (resolved to id)")
|
|
cmd.Flags().StringVar(&opts.Name, "name", "", "Custom file name to record (defaults to base name)")
|
|
cmd.Flags().BoolVar(&opts.JSONOut, "json", false, "Output JSON envelope")
|
|
cmd.MarkFlagsMutuallyExclusive("kb-id", "kb")
|
|
agent.SetAgentHelp(cmd, "Uploads one local file to the resolved KB. Refuses non-regular files (dir / symlink). Returns data: Knowledge object with id, parse_status. Pass --kb-id outside a linked project.")
|
|
return cmd
|
|
}
|
|
|
|
// validateUploadPath checks that path exists and refers to a regular file.
|
|
// Symlinks and directories are rejected up-front so users get a typed error
|
|
// instead of an opaque SDK failure mid-upload. os.Stat (not Lstat) is used
|
|
// here so a symlink to a regular file is accepted — that matches what
|
|
// `cp` / `git add` do, and the SDK opens the file via os.Open which follows
|
|
// symlinks anyway.
|
|
func validateUploadPath(path string) error {
|
|
info, err := os.Stat(path)
|
|
if err != nil {
|
|
if os.IsNotExist(err) {
|
|
return cmdutil.Wrapf(cmdutil.CodeUploadFileNotFound, err, "file not found: %s", path)
|
|
}
|
|
return cmdutil.Wrapf(cmdutil.CodeLocalFileIO, err, "stat %s", path)
|
|
}
|
|
if !info.Mode().IsRegular() {
|
|
return cmdutil.NewError(cmdutil.CodeInputInvalidArgument,
|
|
fmt.Sprintf("not a regular file: %s (directories and devices are not supported)", path))
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func runUpload(ctx context.Context, opts *UploadOptions, svc UploadService, kbID, path string) error {
|
|
if opts.DryRun {
|
|
return cmdutil.EmitDryRun(opts.JSONOut,
|
|
map[string]string{"file": path, "kb_id": kbID, "name": opts.Name},
|
|
&format.Meta{KBID: kbID},
|
|
&format.Risk{Level: format.RiskWrite, Action: fmt.Sprintf("upload %s to kb %s", path, kbID)})
|
|
}
|
|
|
|
k, err := svc.CreateKnowledgeFromFile(ctx, kbID, path, nil /*metadata*/, nil /*enableMultimodel*/, opts.Name, uploadChannel)
|
|
if err != nil {
|
|
return cmdutil.Wrapf(cmdutil.ClassifyHTTPError(err), err, "upload %s", path)
|
|
}
|
|
|
|
if opts.JSONOut {
|
|
risk := &format.Risk{Level: format.RiskWrite, Action: fmt.Sprintf("uploaded %s", path)}
|
|
return format.WriteEnvelope(iostreams.IO.Out, format.SuccessWithRisk(k, &format.Meta{KBID: kbID}, risk))
|
|
}
|
|
displayed := opts.Name
|
|
if displayed == "" {
|
|
displayed = k.FileName
|
|
}
|
|
if displayed == "" {
|
|
displayed = path
|
|
}
|
|
fmt.Fprintf(iostreams.IO.Out, "✓ Uploaded %q (id: %s)\n", displayed, k.ID)
|
|
return nil
|
|
}
|