feat(cli): agent-first WeKnora CLI
The `weknora` command-line client for the WeKnora RAG server. Full command surface: kb / doc / chunk / session / message / agent / model / search / chat / auth / profile / link / api / mcp / skills / config / doctor / schema / exit-codes. Agent-first wire contract: JSON envelope by default, typed error codes mapped to stable exit codes, error.retry_argv / retryable / partial-failure status, global --dry-run preview, the exit-10 confirmation protocol for writes, and control/ANSI/Bidi input hygiene. Stateless env-credential auth (WEKNORA_API_KEY / WEKNORA_TOKEN + WEKNORA_HOST) for headless/CI/agent use. A curated read-only MCP tool surface (`mcp serve`) and embedded Agent Skills (`skills install`). Extensive unit + contract-golden tests and CI.
This commit is contained in:
+28
-19
@@ -3,7 +3,6 @@ package kb
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"slices"
|
||||
"strings"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
@@ -36,7 +35,7 @@ type CreateOptions struct {
|
||||
|
||||
// storageProviderValues mirrors the server enum in
|
||||
// internal/types/knowledgebase.go:StorageProviderConfig.Provider.
|
||||
var storageProviderValues = []string{"local", "minio", "cos", "tos", "s3", "oss", "ks3"}
|
||||
var storageProviderValues = []string{"local", "minio", "cos", "tos", "s3", "oss", "ks3", "obs"}
|
||||
|
||||
// CreateService is the narrow SDK surface this command depends on.
|
||||
// *sdk.Client satisfies it via duck typing.
|
||||
@@ -60,16 +59,16 @@ func NewCmdCreate(f *cmdutil.Factory) *cobra.Command {
|
||||
fopts.ResolveDefault(iostreams.IO.IsStdoutTTY())
|
||||
opts.Name = args[0]
|
||||
// Validate --storage-provider enum before the dry-run gate so
|
||||
// --dry-run rejects identically to the live path. Same typed
|
||||
// FlagError as runCreate (kept there for direct-call callers).
|
||||
if opts.StorageProvider != "" {
|
||||
v := strings.ToLower(strings.TrimSpace(opts.StorageProvider))
|
||||
if !slices.Contains(storageProviderValues, v) {
|
||||
return cmdutil.NewFlagError(fmt.Errorf(
|
||||
"invalid --storage-provider %q: must be %s",
|
||||
opts.StorageProvider, strings.Join(storageProviderValues, " | ")))
|
||||
}
|
||||
// --dry-run rejects identically to the live path. ValidateEnum
|
||||
// returns input.invalid_argument (exit 5) and normalizes to the
|
||||
// canonical lowercase form — consistent with every other enum flag
|
||||
// (model --type, agent --agent-mode, message search --mode).
|
||||
// runCreate re-validates for direct-call callers.
|
||||
canonSP, err := cmdutil.ValidateEnum("storage-provider", opts.StorageProvider, storageProviderValues)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
opts.StorageProvider = canonSP
|
||||
if handled, err := cmdutil.HandleDryRun(c, opts.DryRun, cmdutil.DryRunPlan{
|
||||
Action: "kb.create",
|
||||
Args: map[string]any{
|
||||
@@ -83,11 +82,18 @@ func NewCmdCreate(f *cmdutil.Factory) *cobra.Command {
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
// --embedding-model accepts a model id or name (a UUID passes
|
||||
// through; a name resolves among Embedding models). Configuring a
|
||||
// KB's models fully is `weknora kb init`; this just pre-sets the
|
||||
// embedding model at creation.
|
||||
if opts.EmbeddingModel, err = cmdutil.ResolveModelRef(c.Context(), cli, opts.EmbeddingModel, "Embedding"); err != nil {
|
||||
return err
|
||||
}
|
||||
return runCreate(c.Context(), opts, fopts, cli)
|
||||
},
|
||||
}
|
||||
cmd.Flags().StringVar(&opts.Description, "description", "", "Knowledge base description (optional)")
|
||||
cmd.Flags().StringVar(&opts.EmbeddingModel, "embedding-model", "", "Embedding model ID (optional; server picks default when unset)")
|
||||
cmd.Flags().StringVar(&opts.EmbeddingModel, "embedding-model", "", "Embedding model id or name (optional; configure models fully with `weknora kb init`)")
|
||||
cmd.Flags().StringVar(&opts.StorageProvider, "storage-provider", "",
|
||||
"Storage provider for documents in this KB: "+strings.Join(storageProviderValues, " | ")+" (optional; server default when unset)")
|
||||
cmdutil.AddFormatFlag(cmd, kbCreateFields...)
|
||||
@@ -95,7 +101,12 @@ func NewCmdCreate(f *cmdutil.Factory) *cobra.Command {
|
||||
cmdutil.SetAgentHelp(cmd, cmdutil.AgentHelp{
|
||||
UsedFor: "Create a new knowledge base with the given name. Emits the created KB object with its id.",
|
||||
RequiredFlags: []string{"<name> (positional)"},
|
||||
Output: "envelope.data is the created KnowledgeBase object with id, name, type, embedding_model_id",
|
||||
Examples: []string{
|
||||
`weknora kb create "Eng Docs"`,
|
||||
`weknora kb create "Eng Docs" --description "engineering knowledge base"`,
|
||||
`weknora kb create "Eng Docs" --jq .data.id # capture id to chain into doc upload --kb`,
|
||||
},
|
||||
Output: "envelope.data is the created KnowledgeBase object with id, name, type, embedding_model_id",
|
||||
})
|
||||
return cmd
|
||||
}
|
||||
@@ -115,13 +126,11 @@ func runCreate(ctx context.Context, opts *CreateOptions, fopts *cmdutil.FormatOp
|
||||
req.EmbeddingModelID = opts.EmbeddingModel
|
||||
}
|
||||
if opts.StorageProvider != "" {
|
||||
v := strings.ToLower(strings.TrimSpace(opts.StorageProvider))
|
||||
if !slices.Contains(storageProviderValues, v) {
|
||||
return cmdutil.NewFlagError(fmt.Errorf(
|
||||
"invalid --storage-provider %q: must be %s",
|
||||
opts.StorageProvider, strings.Join(storageProviderValues, " | ")))
|
||||
canonSP, err := cmdutil.ValidateEnum("storage-provider", opts.StorageProvider, storageProviderValues)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
req.StorageProviderConfig = &sdk.StorageProviderConfig{Provider: v}
|
||||
req.StorageProviderConfig = &sdk.StorageProviderConfig{Provider: canonSP}
|
||||
}
|
||||
|
||||
created, err := svc.CreateKnowledgeBase(ctx, req)
|
||||
|
||||
Reference in New Issue
Block a user