WeKnora/cli/cmd/kb/create.go

170 lines
6.7 KiB
Go
Raw Normal View History

package kb
import (
"context"
"fmt"
"strings"
"github.com/spf13/cobra"
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
"github.com/Tencent/WeKnora/cli/internal/iostreams"
feat(cli)!: v0.10 reliability, agent-UX, and command-surface hardening A hardening + finalization pass over the agent-first CLI: correctness fixes, richer machine-readable signals, flag/naming consistency, and a symmetric config surface. Pre-1.0, so it includes breaking renames. Correctness: - agent update: resolve/validate --model/--rerank-model (was storing a bogus name verbatim, corrupting config.model_id). - doctor: honor WEKNORA_HOST / WEKNORA_API_KEY (headless path no longer reports "no host configured"). - session ask / MCP session_ask: text answer was empty on non-TTY — the agent stream sets Done=true on an intermediate agent_query frame before the answer, and AgentAccumulator treated the first Done as terminal. Terminate on the `complete` event (new sdk.AgentResponseTypeComplete), not a per-frame Done. - batch exit codes: any per-item failure collapses to operation.failed (exit 1), including `doc upload --recursive` partial failures — a permanent per-file failure (e.g. a duplicate) no longer surfaces as a retryable exit 7 an agent would loop on; per-item typed errors stay in the envelope. Agent-first signals & discovery: - error.exit_code in the envelope (type + exit_code disambiguate the input.invalid_argument exit-2-vs-5 split in one JSON read). - meta.hint on empty content search and on draft doc create; doc wait fails fast on a never-parsing draft instead of hanging to --timeout. - retrieval-readiness is visible in the natural flow: kb status / kb check emit retrieval_ready, and kb create hints the fix when no embedding model is bound — an unconfigured KB no longer looks silently healthy. - schema contract completeness: every leaf declares output + >=1 example (drift-guarded); output strings match the meta actually emitted; chunk list and search docs now emit meta.total_count (both previously dropped it). - schema tolerates a quoted multi-word command label; zero-state auth — and `link` with no profile — point at profile setup / the headless WEKNORA_KB_ID path instead of looping on `auth login`. - id-addressed reads tolerate a redundant --kb (doc view/wait, chunk list/view accept and ignore it, declared in schema) so a carried-over --kb doesn't exit 2; streaming commands warn that --jq does not apply to an NDJSON stream. - keep JSON-always as the default; --jq hints spell out the .data path. Consistency & gating: - doc create: drop the deprecated --name alias (--title only; pre-1.0 break). - chunk list --limit aligned to 1..10000; model list --limit/-L with has_more/total_count; api write-gates -X PUT/PATCH (exit 10); skills install expands a leading ~. - docs corrected: search docs / doc list --keyword help is case-insensitive (server does LOWER LIKE); AGENTS.md risk-action list (no phantom kb.init; add model.update / kb.config.set) and batch example (failed item carries `error`); session resume --message id comes from `message list`, not the stream. - auth/profile ergonomics: env credentials are now first-class — `auth token` prints the active WEKNORA_API_KEY / WEKNORA_TOKEN, and auth login/logout/refresh give an env-aware message instead of looping on "run auth login". `auth logout` clears credentials but keeps the profile registered (host preserved for re-login); deleting a profile is `profile remove`'s job (clean logout/remove separation, matching gh / lark). Config surface (symmetric read/write, in-place model edits): - kb config now returns a secret-free KBModelConfigView (was {}); `kb config` reads, new `kb config set` writes; `kb init` removed (misnomer). - kb create --chat-model: retrieval-ready in one step. - model update: edit a model in place (id preserved, references survive) — rotate --api-key-stdin, change base-url / display-name / etc. - session continue-stream renamed to session resume. Docs: AGENTS.md is the single wire-contract source; CHANGELOG slimmed; stale kb-init / continue-stream references removed; skill wire-vocab guard extended. AGENTS.md / weknora-shared SKILL document retrieval_ready (a KB needs an embedding model to be searchable), that --jq does not apply to NDJSON streams, and the env-credential-first auth path; the KB quickstart example now creates a retrieval-ready KB.
2026-07-02 07:53:51 +00:00
"github.com/Tencent/WeKnora/cli/internal/output"
sdk "github.com/Tencent/WeKnora/client"
)
feat(cli): --format / NDJSON / chat & agent invoke / MCP / SetAgentHelp / signal-aware ctx / kb create --storage-provider Adds the structured-output and agent-help surface plus root-level signal handling so AI agents (and humans working through pipes) get a stable wire contract. * --format text|json|ndjson flag, registered per-command on outputs that need it; default text on TTY, json on pipe. --jq <expr> pairs with json / ndjson to filter or project. FormatOptions absorbs JQ; WantsJSON() helper for the JSON dispatch. * WriteNDJSON helper in internal/format/ (per ndjson.org: one JSON value per line, arrays split element-per-line, empty slice → zero bytes). * chat / agent invoke wire --format ndjson via SDK StreamResponse / AgentStreamResponse 1:1 passthrough. Both commands detect ctx.Cancelled in every stream + session-create path and emit a stable "operation.cancelled" code on Ctrl-C / SIGTERM. * main.go wires signal.NotifyContext(SIGINT, SIGTERM) into the root context so long-running commands run their cancellation cleanup (re-emit auto-created session id, etc); the process exits 130 when the context was signal-cancelled, matching Unix convention. * MCP chat / agent_invoke output schemas extended with thinking / tool_calls / assistant_message_id (server-side accumulated; MCP tools/call has no standard partial-response). doc_view and doc_download now use doc_id (not knowledge_id) so agents see a single id naming convention across all tools — matches the chunk_list / search_chunks schemas and the CLI's <doc-id> positional. * SetAgentHelp(cmd, AgentHelp{...}) — opt-in machine-friendly --help payload activated by WEKNORA_AGENT_HELP=1. Applied to chat / kb list. * kb create --storage-provider <local|minio|cos|tos|s3|oss|ks3> — sets the new KB's storage_provider_config.provider at creation time (server does not expose it on update). Required on self-hosted deployments where the server-side default doesn't pre-populate a provider — without it, subsequent doc upload returns a misleading "kb not found".
2026-05-17 17:37:47 +00:00
// kbCreateFields enumerates the fields surfaced for `--format json` discovery
// on `kb create`. The result is the full KnowledgeBase struct; these mirror
// its top-level json tags. Nested config objects are intentionally omitted —
// users wanting them can drop the projection or use --jq.
var kbCreateFields = []string{
"id", "name", "type", "description",
"is_temporary", "is_pinned",
"embedding_model_id", "summary_model_id",
"knowledge_count", "chunk_count",
"is_processing", "processing_count",
"created_at", "updated_at",
}
type CreateOptions struct {
feat(cli): --format / NDJSON / chat & agent invoke / MCP / SetAgentHelp / signal-aware ctx / kb create --storage-provider Adds the structured-output and agent-help surface plus root-level signal handling so AI agents (and humans working through pipes) get a stable wire contract. * --format text|json|ndjson flag, registered per-command on outputs that need it; default text on TTY, json on pipe. --jq <expr> pairs with json / ndjson to filter or project. FormatOptions absorbs JQ; WantsJSON() helper for the JSON dispatch. * WriteNDJSON helper in internal/format/ (per ndjson.org: one JSON value per line, arrays split element-per-line, empty slice → zero bytes). * chat / agent invoke wire --format ndjson via SDK StreamResponse / AgentStreamResponse 1:1 passthrough. Both commands detect ctx.Cancelled in every stream + session-create path and emit a stable "operation.cancelled" code on Ctrl-C / SIGTERM. * main.go wires signal.NotifyContext(SIGINT, SIGTERM) into the root context so long-running commands run their cancellation cleanup (re-emit auto-created session id, etc); the process exits 130 when the context was signal-cancelled, matching Unix convention. * MCP chat / agent_invoke output schemas extended with thinking / tool_calls / assistant_message_id (server-side accumulated; MCP tools/call has no standard partial-response). doc_view and doc_download now use doc_id (not knowledge_id) so agents see a single id naming convention across all tools — matches the chunk_list / search_chunks schemas and the CLI's <doc-id> positional. * SetAgentHelp(cmd, AgentHelp{...}) — opt-in machine-friendly --help payload activated by WEKNORA_AGENT_HELP=1. Applied to chat / kb list. * kb create --storage-provider <local|minio|cos|tos|s3|oss|ks3> — sets the new KB's storage_provider_config.provider at creation time (server does not expose it on update). Required on self-hosted deployments where the server-side default doesn't pre-populate a provider — without it, subsequent doc upload returns a misleading "kb not found".
2026-05-17 17:37:47 +00:00
Name string
Description string
EmbeddingModel string
feat(cli)!: v0.10 reliability, agent-UX, and command-surface hardening A hardening + finalization pass over the agent-first CLI: correctness fixes, richer machine-readable signals, flag/naming consistency, and a symmetric config surface. Pre-1.0, so it includes breaking renames. Correctness: - agent update: resolve/validate --model/--rerank-model (was storing a bogus name verbatim, corrupting config.model_id). - doctor: honor WEKNORA_HOST / WEKNORA_API_KEY (headless path no longer reports "no host configured"). - session ask / MCP session_ask: text answer was empty on non-TTY — the agent stream sets Done=true on an intermediate agent_query frame before the answer, and AgentAccumulator treated the first Done as terminal. Terminate on the `complete` event (new sdk.AgentResponseTypeComplete), not a per-frame Done. - batch exit codes: any per-item failure collapses to operation.failed (exit 1), including `doc upload --recursive` partial failures — a permanent per-file failure (e.g. a duplicate) no longer surfaces as a retryable exit 7 an agent would loop on; per-item typed errors stay in the envelope. Agent-first signals & discovery: - error.exit_code in the envelope (type + exit_code disambiguate the input.invalid_argument exit-2-vs-5 split in one JSON read). - meta.hint on empty content search and on draft doc create; doc wait fails fast on a never-parsing draft instead of hanging to --timeout. - retrieval-readiness is visible in the natural flow: kb status / kb check emit retrieval_ready, and kb create hints the fix when no embedding model is bound — an unconfigured KB no longer looks silently healthy. - schema contract completeness: every leaf declares output + >=1 example (drift-guarded); output strings match the meta actually emitted; chunk list and search docs now emit meta.total_count (both previously dropped it). - schema tolerates a quoted multi-word command label; zero-state auth — and `link` with no profile — point at profile setup / the headless WEKNORA_KB_ID path instead of looping on `auth login`. - id-addressed reads tolerate a redundant --kb (doc view/wait, chunk list/view accept and ignore it, declared in schema) so a carried-over --kb doesn't exit 2; streaming commands warn that --jq does not apply to an NDJSON stream. - keep JSON-always as the default; --jq hints spell out the .data path. Consistency & gating: - doc create: drop the deprecated --name alias (--title only; pre-1.0 break). - chunk list --limit aligned to 1..10000; model list --limit/-L with has_more/total_count; api write-gates -X PUT/PATCH (exit 10); skills install expands a leading ~. - docs corrected: search docs / doc list --keyword help is case-insensitive (server does LOWER LIKE); AGENTS.md risk-action list (no phantom kb.init; add model.update / kb.config.set) and batch example (failed item carries `error`); session resume --message id comes from `message list`, not the stream. - auth/profile ergonomics: env credentials are now first-class — `auth token` prints the active WEKNORA_API_KEY / WEKNORA_TOKEN, and auth login/logout/refresh give an env-aware message instead of looping on "run auth login". `auth logout` clears credentials but keeps the profile registered (host preserved for re-login); deleting a profile is `profile remove`'s job (clean logout/remove separation, matching gh / lark). Config surface (symmetric read/write, in-place model edits): - kb config now returns a secret-free KBModelConfigView (was {}); `kb config` reads, new `kb config set` writes; `kb init` removed (misnomer). - kb create --chat-model: retrieval-ready in one step. - model update: edit a model in place (id preserved, references survive) — rotate --api-key-stdin, change base-url / display-name / etc. - session continue-stream renamed to session resume. Docs: AGENTS.md is the single wire-contract source; CHANGELOG slimmed; stale kb-init / continue-stream references removed; skill wire-vocab guard extended. AGENTS.md / weknora-shared SKILL document retrieval_ready (a KB needs an embedding model to be searchable), that --jq does not apply to NDJSON streams, and the env-credential-first auth path; the KB quickstart example now creates a retrieval-ready KB.
2026-07-02 07:53:51 +00:00
ChatModel string
feat(cli): --format / NDJSON / chat & agent invoke / MCP / SetAgentHelp / signal-aware ctx / kb create --storage-provider Adds the structured-output and agent-help surface plus root-level signal handling so AI agents (and humans working through pipes) get a stable wire contract. * --format text|json|ndjson flag, registered per-command on outputs that need it; default text on TTY, json on pipe. --jq <expr> pairs with json / ndjson to filter or project. FormatOptions absorbs JQ; WantsJSON() helper for the JSON dispatch. * WriteNDJSON helper in internal/format/ (per ndjson.org: one JSON value per line, arrays split element-per-line, empty slice → zero bytes). * chat / agent invoke wire --format ndjson via SDK StreamResponse / AgentStreamResponse 1:1 passthrough. Both commands detect ctx.Cancelled in every stream + session-create path and emit a stable "operation.cancelled" code on Ctrl-C / SIGTERM. * main.go wires signal.NotifyContext(SIGINT, SIGTERM) into the root context so long-running commands run their cancellation cleanup (re-emit auto-created session id, etc); the process exits 130 when the context was signal-cancelled, matching Unix convention. * MCP chat / agent_invoke output schemas extended with thinking / tool_calls / assistant_message_id (server-side accumulated; MCP tools/call has no standard partial-response). doc_view and doc_download now use doc_id (not knowledge_id) so agents see a single id naming convention across all tools — matches the chunk_list / search_chunks schemas and the CLI's <doc-id> positional. * SetAgentHelp(cmd, AgentHelp{...}) — opt-in machine-friendly --help payload activated by WEKNORA_AGENT_HELP=1. Applied to chat / kb list. * kb create --storage-provider <local|minio|cos|tos|s3|oss|ks3> — sets the new KB's storage_provider_config.provider at creation time (server does not expose it on update). Required on self-hosted deployments where the server-side default doesn't pre-populate a provider — without it, subsequent doc upload returns a misleading "kb not found".
2026-05-17 17:37:47 +00:00
StorageProvider string
feat(cli): --dry-run + risk metadata + validation parity on 19 mutations 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
2026-05-27 20:28:48 +00:00
DryRun bool
}
feat(cli): --format / NDJSON / chat & agent invoke / MCP / SetAgentHelp / signal-aware ctx / kb create --storage-provider Adds the structured-output and agent-help surface plus root-level signal handling so AI agents (and humans working through pipes) get a stable wire contract. * --format text|json|ndjson flag, registered per-command on outputs that need it; default text on TTY, json on pipe. --jq <expr> pairs with json / ndjson to filter or project. FormatOptions absorbs JQ; WantsJSON() helper for the JSON dispatch. * WriteNDJSON helper in internal/format/ (per ndjson.org: one JSON value per line, arrays split element-per-line, empty slice → zero bytes). * chat / agent invoke wire --format ndjson via SDK StreamResponse / AgentStreamResponse 1:1 passthrough. Both commands detect ctx.Cancelled in every stream + session-create path and emit a stable "operation.cancelled" code on Ctrl-C / SIGTERM. * main.go wires signal.NotifyContext(SIGINT, SIGTERM) into the root context so long-running commands run their cancellation cleanup (re-emit auto-created session id, etc); the process exits 130 when the context was signal-cancelled, matching Unix convention. * MCP chat / agent_invoke output schemas extended with thinking / tool_calls / assistant_message_id (server-side accumulated; MCP tools/call has no standard partial-response). doc_view and doc_download now use doc_id (not knowledge_id) so agents see a single id naming convention across all tools — matches the chunk_list / search_chunks schemas and the CLI's <doc-id> positional. * SetAgentHelp(cmd, AgentHelp{...}) — opt-in machine-friendly --help payload activated by WEKNORA_AGENT_HELP=1. Applied to chat / kb list. * kb create --storage-provider <local|minio|cos|tos|s3|oss|ks3> — sets the new KB's storage_provider_config.provider at creation time (server does not expose it on update). Required on self-hosted deployments where the server-side default doesn't pre-populate a provider — without it, subsequent doc upload returns a misleading "kb not found".
2026-05-17 17:37:47 +00:00
// storageProviderValues mirrors the server enum in
// internal/types/knowledgebase.go:StorageProviderConfig.Provider.
var storageProviderValues = []string{"local", "minio", "cos", "tos", "s3", "oss", "ks3", "obs"}
feat(cli): --format / NDJSON / chat & agent invoke / MCP / SetAgentHelp / signal-aware ctx / kb create --storage-provider Adds the structured-output and agent-help surface plus root-level signal handling so AI agents (and humans working through pipes) get a stable wire contract. * --format text|json|ndjson flag, registered per-command on outputs that need it; default text on TTY, json on pipe. --jq <expr> pairs with json / ndjson to filter or project. FormatOptions absorbs JQ; WantsJSON() helper for the JSON dispatch. * WriteNDJSON helper in internal/format/ (per ndjson.org: one JSON value per line, arrays split element-per-line, empty slice → zero bytes). * chat / agent invoke wire --format ndjson via SDK StreamResponse / AgentStreamResponse 1:1 passthrough. Both commands detect ctx.Cancelled in every stream + session-create path and emit a stable "operation.cancelled" code on Ctrl-C / SIGTERM. * main.go wires signal.NotifyContext(SIGINT, SIGTERM) into the root context so long-running commands run their cancellation cleanup (re-emit auto-created session id, etc); the process exits 130 when the context was signal-cancelled, matching Unix convention. * MCP chat / agent_invoke output schemas extended with thinking / tool_calls / assistant_message_id (server-side accumulated; MCP tools/call has no standard partial-response). doc_view and doc_download now use doc_id (not knowledge_id) so agents see a single id naming convention across all tools — matches the chunk_list / search_chunks schemas and the CLI's <doc-id> positional. * SetAgentHelp(cmd, AgentHelp{...}) — opt-in machine-friendly --help payload activated by WEKNORA_AGENT_HELP=1. Applied to chat / kb list. * kb create --storage-provider <local|minio|cos|tos|s3|oss|ks3> — sets the new KB's storage_provider_config.provider at creation time (server does not expose it on update). Required on self-hosted deployments where the server-side default doesn't pre-populate a provider — without it, subsequent doc upload returns a misleading "kb not found".
2026-05-17 17:37:47 +00:00
// CreateService is the narrow SDK surface this command depends on.
// *sdk.Client satisfies it via duck typing.
type CreateService interface {
CreateKnowledgeBase(ctx context.Context, kb *sdk.KnowledgeBase) (*sdk.KnowledgeBase, error)
}
feat(cli): --format / NDJSON / chat & agent invoke / MCP / SetAgentHelp / signal-aware ctx / kb create --storage-provider Adds the structured-output and agent-help surface plus root-level signal handling so AI agents (and humans working through pipes) get a stable wire contract. * --format text|json|ndjson flag, registered per-command on outputs that need it; default text on TTY, json on pipe. --jq <expr> pairs with json / ndjson to filter or project. FormatOptions absorbs JQ; WantsJSON() helper for the JSON dispatch. * WriteNDJSON helper in internal/format/ (per ndjson.org: one JSON value per line, arrays split element-per-line, empty slice → zero bytes). * chat / agent invoke wire --format ndjson via SDK StreamResponse / AgentStreamResponse 1:1 passthrough. Both commands detect ctx.Cancelled in every stream + session-create path and emit a stable "operation.cancelled" code on Ctrl-C / SIGTERM. * main.go wires signal.NotifyContext(SIGINT, SIGTERM) into the root context so long-running commands run their cancellation cleanup (re-emit auto-created session id, etc); the process exits 130 when the context was signal-cancelled, matching Unix convention. * MCP chat / agent_invoke output schemas extended with thinking / tool_calls / assistant_message_id (server-side accumulated; MCP tools/call has no standard partial-response). doc_view and doc_download now use doc_id (not knowledge_id) so agents see a single id naming convention across all tools — matches the chunk_list / search_chunks schemas and the CLI's <doc-id> positional. * SetAgentHelp(cmd, AgentHelp{...}) — opt-in machine-friendly --help payload activated by WEKNORA_AGENT_HELP=1. Applied to chat / kb list. * kb create --storage-provider <local|minio|cos|tos|s3|oss|ks3> — sets the new KB's storage_provider_config.provider at creation time (server does not expose it on update). Required on self-hosted deployments where the server-side default doesn't pre-populate a provider — without it, subsequent doc upload returns a misleading "kb not found".
2026-05-17 17:37:47 +00:00
// NewCmdCreate builds `weknora kb create <name>`. Positional <name> only,
// consistent with `agent create <name>`.
func NewCmdCreate(f *cmdutil.Factory) *cobra.Command {
opts := &CreateOptions{}
cmd := &cobra.Command{
feat(cli): --format / NDJSON / chat & agent invoke / MCP / SetAgentHelp / signal-aware ctx / kb create --storage-provider Adds the structured-output and agent-help surface plus root-level signal handling so AI agents (and humans working through pipes) get a stable wire contract. * --format text|json|ndjson flag, registered per-command on outputs that need it; default text on TTY, json on pipe. --jq <expr> pairs with json / ndjson to filter or project. FormatOptions absorbs JQ; WantsJSON() helper for the JSON dispatch. * WriteNDJSON helper in internal/format/ (per ndjson.org: one JSON value per line, arrays split element-per-line, empty slice → zero bytes). * chat / agent invoke wire --format ndjson via SDK StreamResponse / AgentStreamResponse 1:1 passthrough. Both commands detect ctx.Cancelled in every stream + session-create path and emit a stable "operation.cancelled" code on Ctrl-C / SIGTERM. * main.go wires signal.NotifyContext(SIGINT, SIGTERM) into the root context so long-running commands run their cancellation cleanup (re-emit auto-created session id, etc); the process exits 130 when the context was signal-cancelled, matching Unix convention. * MCP chat / agent_invoke output schemas extended with thinking / tool_calls / assistant_message_id (server-side accumulated; MCP tools/call has no standard partial-response). doc_view and doc_download now use doc_id (not knowledge_id) so agents see a single id naming convention across all tools — matches the chunk_list / search_chunks schemas and the CLI's <doc-id> positional. * SetAgentHelp(cmd, AgentHelp{...}) — opt-in machine-friendly --help payload activated by WEKNORA_AGENT_HELP=1. Applied to chat / kb list. * kb create --storage-provider <local|minio|cos|tos|s3|oss|ks3> — sets the new KB's storage_provider_config.provider at creation time (server does not expose it on update). Required on self-hosted deployments where the server-side default doesn't pre-populate a provider — without it, subsequent doc upload returns a misleading "kb not found".
2026-05-17 17:37:47 +00:00
Use: "create <name>",
Short: "Create a new knowledge base",
feat(cli): --format / NDJSON / chat & agent invoke / MCP / SetAgentHelp / signal-aware ctx / kb create --storage-provider Adds the structured-output and agent-help surface plus root-level signal handling so AI agents (and humans working through pipes) get a stable wire contract. * --format text|json|ndjson flag, registered per-command on outputs that need it; default text on TTY, json on pipe. --jq <expr> pairs with json / ndjson to filter or project. FormatOptions absorbs JQ; WantsJSON() helper for the JSON dispatch. * WriteNDJSON helper in internal/format/ (per ndjson.org: one JSON value per line, arrays split element-per-line, empty slice → zero bytes). * chat / agent invoke wire --format ndjson via SDK StreamResponse / AgentStreamResponse 1:1 passthrough. Both commands detect ctx.Cancelled in every stream + session-create path and emit a stable "operation.cancelled" code on Ctrl-C / SIGTERM. * main.go wires signal.NotifyContext(SIGINT, SIGTERM) into the root context so long-running commands run their cancellation cleanup (re-emit auto-created session id, etc); the process exits 130 when the context was signal-cancelled, matching Unix convention. * MCP chat / agent_invoke output schemas extended with thinking / tool_calls / assistant_message_id (server-side accumulated; MCP tools/call has no standard partial-response). doc_view and doc_download now use doc_id (not knowledge_id) so agents see a single id naming convention across all tools — matches the chunk_list / search_chunks schemas and the CLI's <doc-id> positional. * SetAgentHelp(cmd, AgentHelp{...}) — opt-in machine-friendly --help payload activated by WEKNORA_AGENT_HELP=1. Applied to chat / kb list. * kb create --storage-provider <local|minio|cos|tos|s3|oss|ks3> — sets the new KB's storage_provider_config.provider at creation time (server does not expose it on update). Required on self-hosted deployments where the server-side default doesn't pre-populate a provider — without it, subsequent doc upload returns a misleading "kb not found".
2026-05-17 17:37:47 +00:00
Args: cobra.ExactArgs(1),
RunE: func(c *cobra.Command, args []string) error {
fopts, err := cmdutil.CheckFormatFlag(c)
if err != nil {
return err
}
feat(cli): --format / NDJSON / chat & agent invoke / MCP / SetAgentHelp / signal-aware ctx / kb create --storage-provider Adds the structured-output and agent-help surface plus root-level signal handling so AI agents (and humans working through pipes) get a stable wire contract. * --format text|json|ndjson flag, registered per-command on outputs that need it; default text on TTY, json on pipe. --jq <expr> pairs with json / ndjson to filter or project. FormatOptions absorbs JQ; WantsJSON() helper for the JSON dispatch. * WriteNDJSON helper in internal/format/ (per ndjson.org: one JSON value per line, arrays split element-per-line, empty slice → zero bytes). * chat / agent invoke wire --format ndjson via SDK StreamResponse / AgentStreamResponse 1:1 passthrough. Both commands detect ctx.Cancelled in every stream + session-create path and emit a stable "operation.cancelled" code on Ctrl-C / SIGTERM. * main.go wires signal.NotifyContext(SIGINT, SIGTERM) into the root context so long-running commands run their cancellation cleanup (re-emit auto-created session id, etc); the process exits 130 when the context was signal-cancelled, matching Unix convention. * MCP chat / agent_invoke output schemas extended with thinking / tool_calls / assistant_message_id (server-side accumulated; MCP tools/call has no standard partial-response). doc_view and doc_download now use doc_id (not knowledge_id) so agents see a single id naming convention across all tools — matches the chunk_list / search_chunks schemas and the CLI's <doc-id> positional. * SetAgentHelp(cmd, AgentHelp{...}) — opt-in machine-friendly --help payload activated by WEKNORA_AGENT_HELP=1. Applied to chat / kb list. * kb create --storage-provider <local|minio|cos|tos|s3|oss|ks3> — sets the new KB's storage_provider_config.provider at creation time (server does not expose it on update). Required on self-hosted deployments where the server-side default doesn't pre-populate a provider — without it, subsequent doc upload returns a misleading "kb not found".
2026-05-17 17:37:47 +00:00
fopts.ResolveDefault(iostreams.IO.IsStdoutTTY())
opts.Name = args[0]
feat(cli): --dry-run + risk metadata + validation parity on 19 mutations 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
2026-05-27 20:28:48 +00:00
// Validate --storage-provider enum before the dry-run gate so
// --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
feat(cli): --dry-run + risk metadata + validation parity on 19 mutations 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
2026-05-27 20:28:48 +00:00
}
opts.StorageProvider = canonSP
feat(cli): --dry-run + risk metadata + validation parity on 19 mutations 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
2026-05-27 20:28:48 +00:00
if handled, err := cmdutil.HandleDryRun(c, opts.DryRun, cmdutil.DryRunPlan{
Action: "kb.create",
Args: map[string]any{
"name": opts.Name,
"description": opts.Description,
},
}); handled {
return err
}
cli, err := f.Client()
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
feat(cli)!: v0.10 reliability, agent-UX, and command-surface hardening A hardening + finalization pass over the agent-first CLI: correctness fixes, richer machine-readable signals, flag/naming consistency, and a symmetric config surface. Pre-1.0, so it includes breaking renames. Correctness: - agent update: resolve/validate --model/--rerank-model (was storing a bogus name verbatim, corrupting config.model_id). - doctor: honor WEKNORA_HOST / WEKNORA_API_KEY (headless path no longer reports "no host configured"). - session ask / MCP session_ask: text answer was empty on non-TTY — the agent stream sets Done=true on an intermediate agent_query frame before the answer, and AgentAccumulator treated the first Done as terminal. Terminate on the `complete` event (new sdk.AgentResponseTypeComplete), not a per-frame Done. - batch exit codes: any per-item failure collapses to operation.failed (exit 1), including `doc upload --recursive` partial failures — a permanent per-file failure (e.g. a duplicate) no longer surfaces as a retryable exit 7 an agent would loop on; per-item typed errors stay in the envelope. Agent-first signals & discovery: - error.exit_code in the envelope (type + exit_code disambiguate the input.invalid_argument exit-2-vs-5 split in one JSON read). - meta.hint on empty content search and on draft doc create; doc wait fails fast on a never-parsing draft instead of hanging to --timeout. - retrieval-readiness is visible in the natural flow: kb status / kb check emit retrieval_ready, and kb create hints the fix when no embedding model is bound — an unconfigured KB no longer looks silently healthy. - schema contract completeness: every leaf declares output + >=1 example (drift-guarded); output strings match the meta actually emitted; chunk list and search docs now emit meta.total_count (both previously dropped it). - schema tolerates a quoted multi-word command label; zero-state auth — and `link` with no profile — point at profile setup / the headless WEKNORA_KB_ID path instead of looping on `auth login`. - id-addressed reads tolerate a redundant --kb (doc view/wait, chunk list/view accept and ignore it, declared in schema) so a carried-over --kb doesn't exit 2; streaming commands warn that --jq does not apply to an NDJSON stream. - keep JSON-always as the default; --jq hints spell out the .data path. Consistency & gating: - doc create: drop the deprecated --name alias (--title only; pre-1.0 break). - chunk list --limit aligned to 1..10000; model list --limit/-L with has_more/total_count; api write-gates -X PUT/PATCH (exit 10); skills install expands a leading ~. - docs corrected: search docs / doc list --keyword help is case-insensitive (server does LOWER LIKE); AGENTS.md risk-action list (no phantom kb.init; add model.update / kb.config.set) and batch example (failed item carries `error`); session resume --message id comes from `message list`, not the stream. - auth/profile ergonomics: env credentials are now first-class — `auth token` prints the active WEKNORA_API_KEY / WEKNORA_TOKEN, and auth login/logout/refresh give an env-aware message instead of looping on "run auth login". `auth logout` clears credentials but keeps the profile registered (host preserved for re-login); deleting a profile is `profile remove`'s job (clean logout/remove separation, matching gh / lark). Config surface (symmetric read/write, in-place model edits): - kb config now returns a secret-free KBModelConfigView (was {}); `kb config` reads, new `kb config set` writes; `kb init` removed (misnomer). - kb create --chat-model: retrieval-ready in one step. - model update: edit a model in place (id preserved, references survive) — rotate --api-key-stdin, change base-url / display-name / etc. - session continue-stream renamed to session resume. Docs: AGENTS.md is the single wire-contract source; CHANGELOG slimmed; stale kb-init / continue-stream references removed; skill wire-vocab guard extended. AGENTS.md / weknora-shared SKILL document retrieval_ready (a KB needs an embedding model to be searchable), that --jq does not apply to NDJSON streams, and the env-credential-first auth path; the KB quickstart example now creates a retrieval-ready KB.
2026-07-02 07:53:51 +00:00
// KB's models fully is `weknora kb config set`; 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
}
feat(cli)!: v0.10 reliability, agent-UX, and command-surface hardening A hardening + finalization pass over the agent-first CLI: correctness fixes, richer machine-readable signals, flag/naming consistency, and a symmetric config surface. Pre-1.0, so it includes breaking renames. Correctness: - agent update: resolve/validate --model/--rerank-model (was storing a bogus name verbatim, corrupting config.model_id). - doctor: honor WEKNORA_HOST / WEKNORA_API_KEY (headless path no longer reports "no host configured"). - session ask / MCP session_ask: text answer was empty on non-TTY — the agent stream sets Done=true on an intermediate agent_query frame before the answer, and AgentAccumulator treated the first Done as terminal. Terminate on the `complete` event (new sdk.AgentResponseTypeComplete), not a per-frame Done. - batch exit codes: any per-item failure collapses to operation.failed (exit 1), including `doc upload --recursive` partial failures — a permanent per-file failure (e.g. a duplicate) no longer surfaces as a retryable exit 7 an agent would loop on; per-item typed errors stay in the envelope. Agent-first signals & discovery: - error.exit_code in the envelope (type + exit_code disambiguate the input.invalid_argument exit-2-vs-5 split in one JSON read). - meta.hint on empty content search and on draft doc create; doc wait fails fast on a never-parsing draft instead of hanging to --timeout. - retrieval-readiness is visible in the natural flow: kb status / kb check emit retrieval_ready, and kb create hints the fix when no embedding model is bound — an unconfigured KB no longer looks silently healthy. - schema contract completeness: every leaf declares output + >=1 example (drift-guarded); output strings match the meta actually emitted; chunk list and search docs now emit meta.total_count (both previously dropped it). - schema tolerates a quoted multi-word command label; zero-state auth — and `link` with no profile — point at profile setup / the headless WEKNORA_KB_ID path instead of looping on `auth login`. - id-addressed reads tolerate a redundant --kb (doc view/wait, chunk list/view accept and ignore it, declared in schema) so a carried-over --kb doesn't exit 2; streaming commands warn that --jq does not apply to an NDJSON stream. - keep JSON-always as the default; --jq hints spell out the .data path. Consistency & gating: - doc create: drop the deprecated --name alias (--title only; pre-1.0 break). - chunk list --limit aligned to 1..10000; model list --limit/-L with has_more/total_count; api write-gates -X PUT/PATCH (exit 10); skills install expands a leading ~. - docs corrected: search docs / doc list --keyword help is case-insensitive (server does LOWER LIKE); AGENTS.md risk-action list (no phantom kb.init; add model.update / kb.config.set) and batch example (failed item carries `error`); session resume --message id comes from `message list`, not the stream. - auth/profile ergonomics: env credentials are now first-class — `auth token` prints the active WEKNORA_API_KEY / WEKNORA_TOKEN, and auth login/logout/refresh give an env-aware message instead of looping on "run auth login". `auth logout` clears credentials but keeps the profile registered (host preserved for re-login); deleting a profile is `profile remove`'s job (clean logout/remove separation, matching gh / lark). Config surface (symmetric read/write, in-place model edits): - kb config now returns a secret-free KBModelConfigView (was {}); `kb config` reads, new `kb config set` writes; `kb init` removed (misnomer). - kb create --chat-model: retrieval-ready in one step. - model update: edit a model in place (id preserved, references survive) — rotate --api-key-stdin, change base-url / display-name / etc. - session continue-stream renamed to session resume. Docs: AGENTS.md is the single wire-contract source; CHANGELOG slimmed; stale kb-init / continue-stream references removed; skill wire-vocab guard extended. AGENTS.md / weknora-shared SKILL document retrieval_ready (a KB needs an embedding model to be searchable), that --jq does not apply to NDJSON streams, and the env-credential-first auth path; the KB quickstart example now creates a retrieval-ready KB.
2026-07-02 07:53:51 +00:00
// --chat-model (id or name) pre-sets the KB's LLM at creation, so a
// KB can be born retrieval-ready in one step. Full model config
// (rerank / multimodal) is still `weknora kb config set`.
if opts.ChatModel, err = cmdutil.ResolveModelRef(c.Context(), cli, opts.ChatModel, "KnowledgeQA"); err != nil {
return err
}
feat(cli): --format / NDJSON / chat & agent invoke / MCP / SetAgentHelp / signal-aware ctx / kb create --storage-provider Adds the structured-output and agent-help surface plus root-level signal handling so AI agents (and humans working through pipes) get a stable wire contract. * --format text|json|ndjson flag, registered per-command on outputs that need it; default text on TTY, json on pipe. --jq <expr> pairs with json / ndjson to filter or project. FormatOptions absorbs JQ; WantsJSON() helper for the JSON dispatch. * WriteNDJSON helper in internal/format/ (per ndjson.org: one JSON value per line, arrays split element-per-line, empty slice → zero bytes). * chat / agent invoke wire --format ndjson via SDK StreamResponse / AgentStreamResponse 1:1 passthrough. Both commands detect ctx.Cancelled in every stream + session-create path and emit a stable "operation.cancelled" code on Ctrl-C / SIGTERM. * main.go wires signal.NotifyContext(SIGINT, SIGTERM) into the root context so long-running commands run their cancellation cleanup (re-emit auto-created session id, etc); the process exits 130 when the context was signal-cancelled, matching Unix convention. * MCP chat / agent_invoke output schemas extended with thinking / tool_calls / assistant_message_id (server-side accumulated; MCP tools/call has no standard partial-response). doc_view and doc_download now use doc_id (not knowledge_id) so agents see a single id naming convention across all tools — matches the chunk_list / search_chunks schemas and the CLI's <doc-id> positional. * SetAgentHelp(cmd, AgentHelp{...}) — opt-in machine-friendly --help payload activated by WEKNORA_AGENT_HELP=1. Applied to chat / kb list. * kb create --storage-provider <local|minio|cos|tos|s3|oss|ks3> — sets the new KB's storage_provider_config.provider at creation time (server does not expose it on update). Required on self-hosted deployments where the server-side default doesn't pre-populate a provider — without it, subsequent doc upload returns a misleading "kb not found".
2026-05-17 17:37:47 +00:00
return runCreate(c.Context(), opts, fopts, cli)
},
}
cmd.Flags().StringVar(&opts.Description, "description", "", "Knowledge base description (optional)")
feat(cli)!: v0.10 reliability, agent-UX, and command-surface hardening A hardening + finalization pass over the agent-first CLI: correctness fixes, richer machine-readable signals, flag/naming consistency, and a symmetric config surface. Pre-1.0, so it includes breaking renames. Correctness: - agent update: resolve/validate --model/--rerank-model (was storing a bogus name verbatim, corrupting config.model_id). - doctor: honor WEKNORA_HOST / WEKNORA_API_KEY (headless path no longer reports "no host configured"). - session ask / MCP session_ask: text answer was empty on non-TTY — the agent stream sets Done=true on an intermediate agent_query frame before the answer, and AgentAccumulator treated the first Done as terminal. Terminate on the `complete` event (new sdk.AgentResponseTypeComplete), not a per-frame Done. - batch exit codes: any per-item failure collapses to operation.failed (exit 1), including `doc upload --recursive` partial failures — a permanent per-file failure (e.g. a duplicate) no longer surfaces as a retryable exit 7 an agent would loop on; per-item typed errors stay in the envelope. Agent-first signals & discovery: - error.exit_code in the envelope (type + exit_code disambiguate the input.invalid_argument exit-2-vs-5 split in one JSON read). - meta.hint on empty content search and on draft doc create; doc wait fails fast on a never-parsing draft instead of hanging to --timeout. - retrieval-readiness is visible in the natural flow: kb status / kb check emit retrieval_ready, and kb create hints the fix when no embedding model is bound — an unconfigured KB no longer looks silently healthy. - schema contract completeness: every leaf declares output + >=1 example (drift-guarded); output strings match the meta actually emitted; chunk list and search docs now emit meta.total_count (both previously dropped it). - schema tolerates a quoted multi-word command label; zero-state auth — and `link` with no profile — point at profile setup / the headless WEKNORA_KB_ID path instead of looping on `auth login`. - id-addressed reads tolerate a redundant --kb (doc view/wait, chunk list/view accept and ignore it, declared in schema) so a carried-over --kb doesn't exit 2; streaming commands warn that --jq does not apply to an NDJSON stream. - keep JSON-always as the default; --jq hints spell out the .data path. Consistency & gating: - doc create: drop the deprecated --name alias (--title only; pre-1.0 break). - chunk list --limit aligned to 1..10000; model list --limit/-L with has_more/total_count; api write-gates -X PUT/PATCH (exit 10); skills install expands a leading ~. - docs corrected: search docs / doc list --keyword help is case-insensitive (server does LOWER LIKE); AGENTS.md risk-action list (no phantom kb.init; add model.update / kb.config.set) and batch example (failed item carries `error`); session resume --message id comes from `message list`, not the stream. - auth/profile ergonomics: env credentials are now first-class — `auth token` prints the active WEKNORA_API_KEY / WEKNORA_TOKEN, and auth login/logout/refresh give an env-aware message instead of looping on "run auth login". `auth logout` clears credentials but keeps the profile registered (host preserved for re-login); deleting a profile is `profile remove`'s job (clean logout/remove separation, matching gh / lark). Config surface (symmetric read/write, in-place model edits): - kb config now returns a secret-free KBModelConfigView (was {}); `kb config` reads, new `kb config set` writes; `kb init` removed (misnomer). - kb create --chat-model: retrieval-ready in one step. - model update: edit a model in place (id preserved, references survive) — rotate --api-key-stdin, change base-url / display-name / etc. - session continue-stream renamed to session resume. Docs: AGENTS.md is the single wire-contract source; CHANGELOG slimmed; stale kb-init / continue-stream references removed; skill wire-vocab guard extended. AGENTS.md / weknora-shared SKILL document retrieval_ready (a KB needs an embedding model to be searchable), that --jq does not apply to NDJSON streams, and the env-credential-first auth path; the KB quickstart example now creates a retrieval-ready KB.
2026-07-02 07:53:51 +00:00
cmd.Flags().StringVar(&opts.EmbeddingModel, "embedding-model", "", "Embedding model id or name (optional; makes the KB retrieval-ready at creation)")
cmd.Flags().StringVar(&opts.ChatModel, "chat-model", "", "Chat/LLM model id or name (optional; pre-set the KB's answer model at creation)")
feat(cli): --format / NDJSON / chat & agent invoke / MCP / SetAgentHelp / signal-aware ctx / kb create --storage-provider Adds the structured-output and agent-help surface plus root-level signal handling so AI agents (and humans working through pipes) get a stable wire contract. * --format text|json|ndjson flag, registered per-command on outputs that need it; default text on TTY, json on pipe. --jq <expr> pairs with json / ndjson to filter or project. FormatOptions absorbs JQ; WantsJSON() helper for the JSON dispatch. * WriteNDJSON helper in internal/format/ (per ndjson.org: one JSON value per line, arrays split element-per-line, empty slice → zero bytes). * chat / agent invoke wire --format ndjson via SDK StreamResponse / AgentStreamResponse 1:1 passthrough. Both commands detect ctx.Cancelled in every stream + session-create path and emit a stable "operation.cancelled" code on Ctrl-C / SIGTERM. * main.go wires signal.NotifyContext(SIGINT, SIGTERM) into the root context so long-running commands run their cancellation cleanup (re-emit auto-created session id, etc); the process exits 130 when the context was signal-cancelled, matching Unix convention. * MCP chat / agent_invoke output schemas extended with thinking / tool_calls / assistant_message_id (server-side accumulated; MCP tools/call has no standard partial-response). doc_view and doc_download now use doc_id (not knowledge_id) so agents see a single id naming convention across all tools — matches the chunk_list / search_chunks schemas and the CLI's <doc-id> positional. * SetAgentHelp(cmd, AgentHelp{...}) — opt-in machine-friendly --help payload activated by WEKNORA_AGENT_HELP=1. Applied to chat / kb list. * kb create --storage-provider <local|minio|cos|tos|s3|oss|ks3> — sets the new KB's storage_provider_config.provider at creation time (server does not expose it on update). Required on self-hosted deployments where the server-side default doesn't pre-populate a provider — without it, subsequent doc upload returns a misleading "kb not found".
2026-05-17 17:37:47 +00:00
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...)
feat(cli): --dry-run + risk metadata + validation parity on 19 mutations 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
2026-05-27 20:28:48 +00:00
cmdutil.AddDryRunFlag(cmd, &opts.DryRun)
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)"},
Examples: []string{
`weknora kb create "Eng Docs"`,
feat(cli)!: v0.10 reliability, agent-UX, and command-surface hardening A hardening + finalization pass over the agent-first CLI: correctness fixes, richer machine-readable signals, flag/naming consistency, and a symmetric config surface. Pre-1.0, so it includes breaking renames. Correctness: - agent update: resolve/validate --model/--rerank-model (was storing a bogus name verbatim, corrupting config.model_id). - doctor: honor WEKNORA_HOST / WEKNORA_API_KEY (headless path no longer reports "no host configured"). - session ask / MCP session_ask: text answer was empty on non-TTY — the agent stream sets Done=true on an intermediate agent_query frame before the answer, and AgentAccumulator treated the first Done as terminal. Terminate on the `complete` event (new sdk.AgentResponseTypeComplete), not a per-frame Done. - batch exit codes: any per-item failure collapses to operation.failed (exit 1), including `doc upload --recursive` partial failures — a permanent per-file failure (e.g. a duplicate) no longer surfaces as a retryable exit 7 an agent would loop on; per-item typed errors stay in the envelope. Agent-first signals & discovery: - error.exit_code in the envelope (type + exit_code disambiguate the input.invalid_argument exit-2-vs-5 split in one JSON read). - meta.hint on empty content search and on draft doc create; doc wait fails fast on a never-parsing draft instead of hanging to --timeout. - retrieval-readiness is visible in the natural flow: kb status / kb check emit retrieval_ready, and kb create hints the fix when no embedding model is bound — an unconfigured KB no longer looks silently healthy. - schema contract completeness: every leaf declares output + >=1 example (drift-guarded); output strings match the meta actually emitted; chunk list and search docs now emit meta.total_count (both previously dropped it). - schema tolerates a quoted multi-word command label; zero-state auth — and `link` with no profile — point at profile setup / the headless WEKNORA_KB_ID path instead of looping on `auth login`. - id-addressed reads tolerate a redundant --kb (doc view/wait, chunk list/view accept and ignore it, declared in schema) so a carried-over --kb doesn't exit 2; streaming commands warn that --jq does not apply to an NDJSON stream. - keep JSON-always as the default; --jq hints spell out the .data path. Consistency & gating: - doc create: drop the deprecated --name alias (--title only; pre-1.0 break). - chunk list --limit aligned to 1..10000; model list --limit/-L with has_more/total_count; api write-gates -X PUT/PATCH (exit 10); skills install expands a leading ~. - docs corrected: search docs / doc list --keyword help is case-insensitive (server does LOWER LIKE); AGENTS.md risk-action list (no phantom kb.init; add model.update / kb.config.set) and batch example (failed item carries `error`); session resume --message id comes from `message list`, not the stream. - auth/profile ergonomics: env credentials are now first-class — `auth token` prints the active WEKNORA_API_KEY / WEKNORA_TOKEN, and auth login/logout/refresh give an env-aware message instead of looping on "run auth login". `auth logout` clears credentials but keeps the profile registered (host preserved for re-login); deleting a profile is `profile remove`'s job (clean logout/remove separation, matching gh / lark). Config surface (symmetric read/write, in-place model edits): - kb config now returns a secret-free KBModelConfigView (was {}); `kb config` reads, new `kb config set` writes; `kb init` removed (misnomer). - kb create --chat-model: retrieval-ready in one step. - model update: edit a model in place (id preserved, references survive) — rotate --api-key-stdin, change base-url / display-name / etc. - session continue-stream renamed to session resume. Docs: AGENTS.md is the single wire-contract source; CHANGELOG slimmed; stale kb-init / continue-stream references removed; skill wire-vocab guard extended. AGENTS.md / weknora-shared SKILL document retrieval_ready (a KB needs an embedding model to be searchable), that --jq does not apply to NDJSON streams, and the env-credential-first auth path; the KB quickstart example now creates a retrieval-ready KB.
2026-07-02 07:53:51 +00:00
`weknora kb create "Eng Docs" --embedding-model text-embedding-3-small --chat-model gpt-4o-mini # retrieval-ready in one step`,
`weknora kb create "Eng Docs" --jq .data.id # capture id to chain into doc upload --kb`,
},
feat(cli)!: v0.10 reliability, agent-UX, and command-surface hardening A hardening + finalization pass over the agent-first CLI: correctness fixes, richer machine-readable signals, flag/naming consistency, and a symmetric config surface. Pre-1.0, so it includes breaking renames. Correctness: - agent update: resolve/validate --model/--rerank-model (was storing a bogus name verbatim, corrupting config.model_id). - doctor: honor WEKNORA_HOST / WEKNORA_API_KEY (headless path no longer reports "no host configured"). - session ask / MCP session_ask: text answer was empty on non-TTY — the agent stream sets Done=true on an intermediate agent_query frame before the answer, and AgentAccumulator treated the first Done as terminal. Terminate on the `complete` event (new sdk.AgentResponseTypeComplete), not a per-frame Done. - batch exit codes: any per-item failure collapses to operation.failed (exit 1), including `doc upload --recursive` partial failures — a permanent per-file failure (e.g. a duplicate) no longer surfaces as a retryable exit 7 an agent would loop on; per-item typed errors stay in the envelope. Agent-first signals & discovery: - error.exit_code in the envelope (type + exit_code disambiguate the input.invalid_argument exit-2-vs-5 split in one JSON read). - meta.hint on empty content search and on draft doc create; doc wait fails fast on a never-parsing draft instead of hanging to --timeout. - retrieval-readiness is visible in the natural flow: kb status / kb check emit retrieval_ready, and kb create hints the fix when no embedding model is bound — an unconfigured KB no longer looks silently healthy. - schema contract completeness: every leaf declares output + >=1 example (drift-guarded); output strings match the meta actually emitted; chunk list and search docs now emit meta.total_count (both previously dropped it). - schema tolerates a quoted multi-word command label; zero-state auth — and `link` with no profile — point at profile setup / the headless WEKNORA_KB_ID path instead of looping on `auth login`. - id-addressed reads tolerate a redundant --kb (doc view/wait, chunk list/view accept and ignore it, declared in schema) so a carried-over --kb doesn't exit 2; streaming commands warn that --jq does not apply to an NDJSON stream. - keep JSON-always as the default; --jq hints spell out the .data path. Consistency & gating: - doc create: drop the deprecated --name alias (--title only; pre-1.0 break). - chunk list --limit aligned to 1..10000; model list --limit/-L with has_more/total_count; api write-gates -X PUT/PATCH (exit 10); skills install expands a leading ~. - docs corrected: search docs / doc list --keyword help is case-insensitive (server does LOWER LIKE); AGENTS.md risk-action list (no phantom kb.init; add model.update / kb.config.set) and batch example (failed item carries `error`); session resume --message id comes from `message list`, not the stream. - auth/profile ergonomics: env credentials are now first-class — `auth token` prints the active WEKNORA_API_KEY / WEKNORA_TOKEN, and auth login/logout/refresh give an env-aware message instead of looping on "run auth login". `auth logout` clears credentials but keeps the profile registered (host preserved for re-login); deleting a profile is `profile remove`'s job (clean logout/remove separation, matching gh / lark). Config surface (symmetric read/write, in-place model edits): - kb config now returns a secret-free KBModelConfigView (was {}); `kb config` reads, new `kb config set` writes; `kb init` removed (misnomer). - kb create --chat-model: retrieval-ready in one step. - model update: edit a model in place (id preserved, references survive) — rotate --api-key-stdin, change base-url / display-name / etc. - session continue-stream renamed to session resume. Docs: AGENTS.md is the single wire-contract source; CHANGELOG slimmed; stale kb-init / continue-stream references removed; skill wire-vocab guard extended. AGENTS.md / weknora-shared SKILL document retrieval_ready (a KB needs an embedding model to be searchable), that --jq does not apply to NDJSON streams, and the env-credential-first auth path; the KB quickstart example now creates a retrieval-ready KB.
2026-07-02 07:53:51 +00:00
Output: "envelope.data is the created KnowledgeBase object with id, name, type, embedding_model_id, summary_model_id",
})
return cmd
}
feat(cli): --format / NDJSON / chat & agent invoke / MCP / SetAgentHelp / signal-aware ctx / kb create --storage-provider Adds the structured-output and agent-help surface plus root-level signal handling so AI agents (and humans working through pipes) get a stable wire contract. * --format text|json|ndjson flag, registered per-command on outputs that need it; default text on TTY, json on pipe. --jq <expr> pairs with json / ndjson to filter or project. FormatOptions absorbs JQ; WantsJSON() helper for the JSON dispatch. * WriteNDJSON helper in internal/format/ (per ndjson.org: one JSON value per line, arrays split element-per-line, empty slice → zero bytes). * chat / agent invoke wire --format ndjson via SDK StreamResponse / AgentStreamResponse 1:1 passthrough. Both commands detect ctx.Cancelled in every stream + session-create path and emit a stable "operation.cancelled" code on Ctrl-C / SIGTERM. * main.go wires signal.NotifyContext(SIGINT, SIGTERM) into the root context so long-running commands run their cancellation cleanup (re-emit auto-created session id, etc); the process exits 130 when the context was signal-cancelled, matching Unix convention. * MCP chat / agent_invoke output schemas extended with thinking / tool_calls / assistant_message_id (server-side accumulated; MCP tools/call has no standard partial-response). doc_view and doc_download now use doc_id (not knowledge_id) so agents see a single id naming convention across all tools — matches the chunk_list / search_chunks schemas and the CLI's <doc-id> positional. * SetAgentHelp(cmd, AgentHelp{...}) — opt-in machine-friendly --help payload activated by WEKNORA_AGENT_HELP=1. Applied to chat / kb list. * kb create --storage-provider <local|minio|cos|tos|s3|oss|ks3> — sets the new KB's storage_provider_config.provider at creation time (server does not expose it on update). Required on self-hosted deployments where the server-side default doesn't pre-populate a provider — without it, subsequent doc upload returns a misleading "kb not found".
2026-05-17 17:37:47 +00:00
func runCreate(ctx context.Context, opts *CreateOptions, fopts *cmdutil.FormatOptions, svc CreateService) error {
refactor(cli): delete envelope infrastructure, errors to stderr Removes the entire envelope machinery now that every success path emits bare JSON: - cli/internal/format/envelope.go (Envelope, Success, Failure, SuccessWithRisk, WriteEnvelope, Meta, Notice, UpdateNotice, VersionSkewNotice, Risk, RiskLevel, ErrorBody) + tests. - cli/internal/format/filter.go envelope-specific helpers (WriteEnvelopeFiltered, marshalEnvelope, applyFieldFilter, filterDataPayload, filterObjectData); the reusable filterArrayItems / filterObjectKeys / writeJQ stay for bare.go. - cli/internal/cmdutil/exporter.go + tests (envelope-only). - cli/internal/cmdutil/PrintErrorEnvelope + ToErrorBody + operationRiskOf + Error.OperationRisk field + OperationRisk struct. Error path: all errors now go to stderr via cmdutil.PrintError in `code: message\nhint: ...` form, regardless of --json. Stdout stays empty (or holds the partial-success the command already wrote) so downstream `--json | jq` pipelines never have to filter error shapes out of the success stream. Typed exit codes (3 auth.* / 4 resource.not_found / 5 input.* / 6 server.rate_limited / 7 server.* + network.* / 10 input.confirmation_required) carry the failure class for agents that branch on it. Acceptance contract: - envelope_test.go → wire_test.go (TestEnvelopeGolden → TestWireGolden). - testdata/envelopes/ → testdata/wire/. - Error-path cases assert the typed code substring on stderr. - Orphan whoami.*.json goldens deleted. AGENTS.md + README.md rewritten for the bare-data contract: - Drop envelope schema section + dry-run rule. - Document bare JSON on stdout + `code: msg\nhint: …` on stderr. - ADR-3 reframed around bare data and why error separation matters for `--json | jq` pipelines. WriteJSONFiltered short-circuits to WriteJSON when both filters are empty (skip the marshal-buffer round-trip for the common case). Final review pass: - Fix wire-contract bug: `--json id,name` (space form) is broken by pflag's NoOptDefVal; AGENTS.md / README.md / SetAgentHelp + the field-discovery help text all switched to `--json=id,name`. - Fix `weknora api --jq` silently ignored: api.go now routes through WriteJSONFiltered with jopts.JQ. - AGENTS.md: drop the false claim that `auth logout` honors `-y` (logout is local-only with no ConfirmDestructive guard); list the actual destructive commands instead. - Rewrite cli/acceptance/e2e/e2e_test.go for the bare-data wire shape (was still parsing `out["data"]` / `env["ok"]`). - Add `JSONOptions.Emit(w, v)` helper; collapse ~33 repeated `format.WriteJSONFiltered(iostreams.IO.Out, X, jopts.Fields, jopts.JQ)` sites to `jopts.Emit(iostreams.IO.Out, X)` — drops the format import from 22 cmd/* files. - Delete single-caller `cmdutil.MustRequireFlag`; inline as `_ = cmd.MarkFlagRequired(...)` everywhere. - Add `_ = cmd.MarkFlagRequired("name")` to `kb create`; it was the only write command relying on runtime --name validation while `context add` already used the cobra-level mark. - `context use`: register `--json` / `--jq` (was always emitting JSON unconditionally with no human path and no flag — diverged from every other write command); human mode now prints `✓ Switched context to X (was Y)`. - Replace per-package `confirmPrompter` / `scriptedConfirm` / `errPrompter` test doubles with `testutil.ConfirmPrompter`. - Rename `chatService` → `ChatService` (export to match siblings `ListService` / `ViewService`); rename `printUploadSuccess` → `renderUploadSuccess` (siblings use `render*`). - `defaultHint(CodeResourceNotFound)`: drop the hardcoded "list available with `weknora kb list`" — misleading on agent / doc / session 404. Replaced with "verify the resource ID and try again". - Strip stale `v0.2/v0.3` / "envelope" / "v0.0/v0.1 supports only" historical tags from production comments and a few test descriptions.
2026-05-14 17:51:11 +00:00
// Trim defensively in case a caller invokes runCreate directly with
feat(cli): --format / NDJSON / chat & agent invoke / MCP / SetAgentHelp / signal-aware ctx / kb create --storage-provider Adds the structured-output and agent-help surface plus root-level signal handling so AI agents (and humans working through pipes) get a stable wire contract. * --format text|json|ndjson flag, registered per-command on outputs that need it; default text on TTY, json on pipe. --jq <expr> pairs with json / ndjson to filter or project. FormatOptions absorbs JQ; WantsJSON() helper for the JSON dispatch. * WriteNDJSON helper in internal/format/ (per ndjson.org: one JSON value per line, arrays split element-per-line, empty slice → zero bytes). * chat / agent invoke wire --format ndjson via SDK StreamResponse / AgentStreamResponse 1:1 passthrough. Both commands detect ctx.Cancelled in every stream + session-create path and emit a stable "operation.cancelled" code on Ctrl-C / SIGTERM. * main.go wires signal.NotifyContext(SIGINT, SIGTERM) into the root context so long-running commands run their cancellation cleanup (re-emit auto-created session id, etc); the process exits 130 when the context was signal-cancelled, matching Unix convention. * MCP chat / agent_invoke output schemas extended with thinking / tool_calls / assistant_message_id (server-side accumulated; MCP tools/call has no standard partial-response). doc_view and doc_download now use doc_id (not knowledge_id) so agents see a single id naming convention across all tools — matches the chunk_list / search_chunks schemas and the CLI's <doc-id> positional. * SetAgentHelp(cmd, AgentHelp{...}) — opt-in machine-friendly --help payload activated by WEKNORA_AGENT_HELP=1. Applied to chat / kb list. * kb create --storage-provider <local|minio|cos|tos|s3|oss|ks3> — sets the new KB's storage_provider_config.provider at creation time (server does not expose it on update). Required on self-hosted deployments where the server-side default doesn't pre-populate a provider — without it, subsequent doc upload returns a misleading "kb not found".
2026-05-17 17:37:47 +00:00
// whitespace; the cobra layer enforces a non-empty positional from the CLI.
if strings.TrimSpace(opts.Name) == "" {
feat(cli): --format / NDJSON / chat & agent invoke / MCP / SetAgentHelp / signal-aware ctx / kb create --storage-provider Adds the structured-output and agent-help surface plus root-level signal handling so AI agents (and humans working through pipes) get a stable wire contract. * --format text|json|ndjson flag, registered per-command on outputs that need it; default text on TTY, json on pipe. --jq <expr> pairs with json / ndjson to filter or project. FormatOptions absorbs JQ; WantsJSON() helper for the JSON dispatch. * WriteNDJSON helper in internal/format/ (per ndjson.org: one JSON value per line, arrays split element-per-line, empty slice → zero bytes). * chat / agent invoke wire --format ndjson via SDK StreamResponse / AgentStreamResponse 1:1 passthrough. Both commands detect ctx.Cancelled in every stream + session-create path and emit a stable "operation.cancelled" code on Ctrl-C / SIGTERM. * main.go wires signal.NotifyContext(SIGINT, SIGTERM) into the root context so long-running commands run their cancellation cleanup (re-emit auto-created session id, etc); the process exits 130 when the context was signal-cancelled, matching Unix convention. * MCP chat / agent_invoke output schemas extended with thinking / tool_calls / assistant_message_id (server-side accumulated; MCP tools/call has no standard partial-response). doc_view and doc_download now use doc_id (not knowledge_id) so agents see a single id naming convention across all tools — matches the chunk_list / search_chunks schemas and the CLI's <doc-id> positional. * SetAgentHelp(cmd, AgentHelp{...}) — opt-in machine-friendly --help payload activated by WEKNORA_AGENT_HELP=1. Applied to chat / kb list. * kb create --storage-provider <local|minio|cos|tos|s3|oss|ks3> — sets the new KB's storage_provider_config.provider at creation time (server does not expose it on update). Required on self-hosted deployments where the server-side default doesn't pre-populate a provider — without it, subsequent doc upload returns a misleading "kb not found".
2026-05-17 17:37:47 +00:00
return cmdutil.NewError(cmdutil.CodeInputInvalidArgument, "knowledge base name is required")
}
req := &sdk.KnowledgeBase{
Name: opts.Name,
Description: opts.Description,
}
if opts.EmbeddingModel != "" {
req.EmbeddingModelID = opts.EmbeddingModel
}
feat(cli)!: v0.10 reliability, agent-UX, and command-surface hardening A hardening + finalization pass over the agent-first CLI: correctness fixes, richer machine-readable signals, flag/naming consistency, and a symmetric config surface. Pre-1.0, so it includes breaking renames. Correctness: - agent update: resolve/validate --model/--rerank-model (was storing a bogus name verbatim, corrupting config.model_id). - doctor: honor WEKNORA_HOST / WEKNORA_API_KEY (headless path no longer reports "no host configured"). - session ask / MCP session_ask: text answer was empty on non-TTY — the agent stream sets Done=true on an intermediate agent_query frame before the answer, and AgentAccumulator treated the first Done as terminal. Terminate on the `complete` event (new sdk.AgentResponseTypeComplete), not a per-frame Done. - batch exit codes: any per-item failure collapses to operation.failed (exit 1), including `doc upload --recursive` partial failures — a permanent per-file failure (e.g. a duplicate) no longer surfaces as a retryable exit 7 an agent would loop on; per-item typed errors stay in the envelope. Agent-first signals & discovery: - error.exit_code in the envelope (type + exit_code disambiguate the input.invalid_argument exit-2-vs-5 split in one JSON read). - meta.hint on empty content search and on draft doc create; doc wait fails fast on a never-parsing draft instead of hanging to --timeout. - retrieval-readiness is visible in the natural flow: kb status / kb check emit retrieval_ready, and kb create hints the fix when no embedding model is bound — an unconfigured KB no longer looks silently healthy. - schema contract completeness: every leaf declares output + >=1 example (drift-guarded); output strings match the meta actually emitted; chunk list and search docs now emit meta.total_count (both previously dropped it). - schema tolerates a quoted multi-word command label; zero-state auth — and `link` with no profile — point at profile setup / the headless WEKNORA_KB_ID path instead of looping on `auth login`. - id-addressed reads tolerate a redundant --kb (doc view/wait, chunk list/view accept and ignore it, declared in schema) so a carried-over --kb doesn't exit 2; streaming commands warn that --jq does not apply to an NDJSON stream. - keep JSON-always as the default; --jq hints spell out the .data path. Consistency & gating: - doc create: drop the deprecated --name alias (--title only; pre-1.0 break). - chunk list --limit aligned to 1..10000; model list --limit/-L with has_more/total_count; api write-gates -X PUT/PATCH (exit 10); skills install expands a leading ~. - docs corrected: search docs / doc list --keyword help is case-insensitive (server does LOWER LIKE); AGENTS.md risk-action list (no phantom kb.init; add model.update / kb.config.set) and batch example (failed item carries `error`); session resume --message id comes from `message list`, not the stream. - auth/profile ergonomics: env credentials are now first-class — `auth token` prints the active WEKNORA_API_KEY / WEKNORA_TOKEN, and auth login/logout/refresh give an env-aware message instead of looping on "run auth login". `auth logout` clears credentials but keeps the profile registered (host preserved for re-login); deleting a profile is `profile remove`'s job (clean logout/remove separation, matching gh / lark). Config surface (symmetric read/write, in-place model edits): - kb config now returns a secret-free KBModelConfigView (was {}); `kb config` reads, new `kb config set` writes; `kb init` removed (misnomer). - kb create --chat-model: retrieval-ready in one step. - model update: edit a model in place (id preserved, references survive) — rotate --api-key-stdin, change base-url / display-name / etc. - session continue-stream renamed to session resume. Docs: AGENTS.md is the single wire-contract source; CHANGELOG slimmed; stale kb-init / continue-stream references removed; skill wire-vocab guard extended. AGENTS.md / weknora-shared SKILL document retrieval_ready (a KB needs an embedding model to be searchable), that --jq does not apply to NDJSON streams, and the env-credential-first auth path; the KB quickstart example now creates a retrieval-ready KB.
2026-07-02 07:53:51 +00:00
if opts.ChatModel != "" {
req.SummaryModelID = opts.ChatModel
}
feat(cli): --format / NDJSON / chat & agent invoke / MCP / SetAgentHelp / signal-aware ctx / kb create --storage-provider Adds the structured-output and agent-help surface plus root-level signal handling so AI agents (and humans working through pipes) get a stable wire contract. * --format text|json|ndjson flag, registered per-command on outputs that need it; default text on TTY, json on pipe. --jq <expr> pairs with json / ndjson to filter or project. FormatOptions absorbs JQ; WantsJSON() helper for the JSON dispatch. * WriteNDJSON helper in internal/format/ (per ndjson.org: one JSON value per line, arrays split element-per-line, empty slice → zero bytes). * chat / agent invoke wire --format ndjson via SDK StreamResponse / AgentStreamResponse 1:1 passthrough. Both commands detect ctx.Cancelled in every stream + session-create path and emit a stable "operation.cancelled" code on Ctrl-C / SIGTERM. * main.go wires signal.NotifyContext(SIGINT, SIGTERM) into the root context so long-running commands run their cancellation cleanup (re-emit auto-created session id, etc); the process exits 130 when the context was signal-cancelled, matching Unix convention. * MCP chat / agent_invoke output schemas extended with thinking / tool_calls / assistant_message_id (server-side accumulated; MCP tools/call has no standard partial-response). doc_view and doc_download now use doc_id (not knowledge_id) so agents see a single id naming convention across all tools — matches the chunk_list / search_chunks schemas and the CLI's <doc-id> positional. * SetAgentHelp(cmd, AgentHelp{...}) — opt-in machine-friendly --help payload activated by WEKNORA_AGENT_HELP=1. Applied to chat / kb list. * kb create --storage-provider <local|minio|cos|tos|s3|oss|ks3> — sets the new KB's storage_provider_config.provider at creation time (server does not expose it on update). Required on self-hosted deployments where the server-side default doesn't pre-populate a provider — without it, subsequent doc upload returns a misleading "kb not found".
2026-05-17 17:37:47 +00:00
if opts.StorageProvider != "" {
canonSP, err := cmdutil.ValidateEnum("storage-provider", opts.StorageProvider, storageProviderValues)
if err != nil {
return err
feat(cli): --format / NDJSON / chat & agent invoke / MCP / SetAgentHelp / signal-aware ctx / kb create --storage-provider Adds the structured-output and agent-help surface plus root-level signal handling so AI agents (and humans working through pipes) get a stable wire contract. * --format text|json|ndjson flag, registered per-command on outputs that need it; default text on TTY, json on pipe. --jq <expr> pairs with json / ndjson to filter or project. FormatOptions absorbs JQ; WantsJSON() helper for the JSON dispatch. * WriteNDJSON helper in internal/format/ (per ndjson.org: one JSON value per line, arrays split element-per-line, empty slice → zero bytes). * chat / agent invoke wire --format ndjson via SDK StreamResponse / AgentStreamResponse 1:1 passthrough. Both commands detect ctx.Cancelled in every stream + session-create path and emit a stable "operation.cancelled" code on Ctrl-C / SIGTERM. * main.go wires signal.NotifyContext(SIGINT, SIGTERM) into the root context so long-running commands run their cancellation cleanup (re-emit auto-created session id, etc); the process exits 130 when the context was signal-cancelled, matching Unix convention. * MCP chat / agent_invoke output schemas extended with thinking / tool_calls / assistant_message_id (server-side accumulated; MCP tools/call has no standard partial-response). doc_view and doc_download now use doc_id (not knowledge_id) so agents see a single id naming convention across all tools — matches the chunk_list / search_chunks schemas and the CLI's <doc-id> positional. * SetAgentHelp(cmd, AgentHelp{...}) — opt-in machine-friendly --help payload activated by WEKNORA_AGENT_HELP=1. Applied to chat / kb list. * kb create --storage-provider <local|minio|cos|tos|s3|oss|ks3> — sets the new KB's storage_provider_config.provider at creation time (server does not expose it on update). Required on self-hosted deployments where the server-side default doesn't pre-populate a provider — without it, subsequent doc upload returns a misleading "kb not found".
2026-05-17 17:37:47 +00:00
}
req.StorageProviderConfig = &sdk.StorageProviderConfig{Provider: canonSP}
feat(cli): --format / NDJSON / chat & agent invoke / MCP / SetAgentHelp / signal-aware ctx / kb create --storage-provider Adds the structured-output and agent-help surface plus root-level signal handling so AI agents (and humans working through pipes) get a stable wire contract. * --format text|json|ndjson flag, registered per-command on outputs that need it; default text on TTY, json on pipe. --jq <expr> pairs with json / ndjson to filter or project. FormatOptions absorbs JQ; WantsJSON() helper for the JSON dispatch. * WriteNDJSON helper in internal/format/ (per ndjson.org: one JSON value per line, arrays split element-per-line, empty slice → zero bytes). * chat / agent invoke wire --format ndjson via SDK StreamResponse / AgentStreamResponse 1:1 passthrough. Both commands detect ctx.Cancelled in every stream + session-create path and emit a stable "operation.cancelled" code on Ctrl-C / SIGTERM. * main.go wires signal.NotifyContext(SIGINT, SIGTERM) into the root context so long-running commands run their cancellation cleanup (re-emit auto-created session id, etc); the process exits 130 when the context was signal-cancelled, matching Unix convention. * MCP chat / agent_invoke output schemas extended with thinking / tool_calls / assistant_message_id (server-side accumulated; MCP tools/call has no standard partial-response). doc_view and doc_download now use doc_id (not knowledge_id) so agents see a single id naming convention across all tools — matches the chunk_list / search_chunks schemas and the CLI's <doc-id> positional. * SetAgentHelp(cmd, AgentHelp{...}) — opt-in machine-friendly --help payload activated by WEKNORA_AGENT_HELP=1. Applied to chat / kb list. * kb create --storage-provider <local|minio|cos|tos|s3|oss|ks3> — sets the new KB's storage_provider_config.provider at creation time (server does not expose it on update). Required on self-hosted deployments where the server-side default doesn't pre-populate a provider — without it, subsequent doc upload returns a misleading "kb not found".
2026-05-17 17:37:47 +00:00
}
created, err := svc.CreateKnowledgeBase(ctx, req)
if err != nil {
refactor(cli): v0.3 cross-cutting cleanup Cross-cutting findings surfaced by the branch-completion review. Perf bug: - Factory.Client closure was not memoized. Factory.ResolveKB internally calls f.Client() to resolve --kb name → id, then the command's RunE calls f.Client() again. Two SDK clients, two keyring reads, two AuthRetryTransport allocations per name-resolved invocation, with *independent* token state (a refresh in one was invisible to the other). Switched to sync.Once like Secrets already does. Silent bug bait: - cmdutil.NormalizeHost docstring claimed CodeInputMissingFlag for the empty case; code returned CodeInputInvalidArgument. Aligned doc to code (present-but-empty is a bad value, not a missing flag). Agent contract gaps: - Five user-facing subcommands lacked SetAgentHelp: auth login / logout / list / status and chat. Added concise strings with error- code call-outs so agents can branch without parsing human strings. Helper extraction (≥3 callers): - text.KnowledgeDisplayName(fileName, title, id) — byte-identical formatter that was in both cmd/doc/list.go and cmd/search/docs.go. Takes fields directly so internal/text stays SDK-free. - cmdutil.WrapHTTP(cause, fmt, args...) *Error — replaces the `Wrapf(ClassifyHTTPError(err), err, ...)` pattern across 24 SDK call sites. Sed-driven migration; off-pattern shapes in chat.go (used streamErr) and cmdutil/kb.go (in-package) hand-edited. Contract test gains a comment update: post-migration the dominant pattern is WrapHTTP which the AST scanner skips entirely (only NewError/Wrapf selectors inspected); ClassifyHTTPErrorOutputs() bridge still covers the dynamic codes those paths can yield. UX consistency: - cmd/doc/list.go --page-size help now reads "Items per page (1..1000)" matching cmd/session/list.go. The bounds validation already enforced 1..1000; the help text was the last drift. Comment-discipline sweep: - Deleted the WHAT-only "*Options captures `weknora ...` flag state" docstring across 23 files (context, kb, auth, doc, session, search, chat, doctor, link). Where the line carried a real WHY clause (kb/delete, doc/delete, session/delete, kb/edit), kept the WHY and dropped only the leading WHAT phrase. - Stripped third-party project-name attribution from inline comments and one user-visible flag-help string across ~40 files in cli/cmd and cli/internal (plus 4 test-file comments). Removed phrases like "Mirrors `gh X`", "borrowed from lark-cli", "kubectl-style", "gcloud `--project`", "Stripe pattern", and the embedded GitHub URLs pointing at those projects. Behavioral descriptions and the WHY behind each comment are preserved; only the upstream-name attribution is gone. Inspiration / north-star references belong in cli/AGENTS.md (the design doc) and commit messages, not scattered through every file. Triggered by an audit round that surfaced several false / fragile parity claims (e.g. "Mirrors `gh repo edit`" — gh repo edit has no --name flag; "matches gcloud `--project` id-or-name" — gcloud's --project accepts ID only). Rather than fix them one by one, the whole category of in-comment external-project references was stripped uniformly.
2026-05-12 15:42:20 +00:00
return cmdutil.WrapHTTP(err, "create knowledge base")
}
feat(cli)!: v0.10 reliability, agent-UX, and command-surface hardening A hardening + finalization pass over the agent-first CLI: correctness fixes, richer machine-readable signals, flag/naming consistency, and a symmetric config surface. Pre-1.0, so it includes breaking renames. Correctness: - agent update: resolve/validate --model/--rerank-model (was storing a bogus name verbatim, corrupting config.model_id). - doctor: honor WEKNORA_HOST / WEKNORA_API_KEY (headless path no longer reports "no host configured"). - session ask / MCP session_ask: text answer was empty on non-TTY — the agent stream sets Done=true on an intermediate agent_query frame before the answer, and AgentAccumulator treated the first Done as terminal. Terminate on the `complete` event (new sdk.AgentResponseTypeComplete), not a per-frame Done. - batch exit codes: any per-item failure collapses to operation.failed (exit 1), including `doc upload --recursive` partial failures — a permanent per-file failure (e.g. a duplicate) no longer surfaces as a retryable exit 7 an agent would loop on; per-item typed errors stay in the envelope. Agent-first signals & discovery: - error.exit_code in the envelope (type + exit_code disambiguate the input.invalid_argument exit-2-vs-5 split in one JSON read). - meta.hint on empty content search and on draft doc create; doc wait fails fast on a never-parsing draft instead of hanging to --timeout. - retrieval-readiness is visible in the natural flow: kb status / kb check emit retrieval_ready, and kb create hints the fix when no embedding model is bound — an unconfigured KB no longer looks silently healthy. - schema contract completeness: every leaf declares output + >=1 example (drift-guarded); output strings match the meta actually emitted; chunk list and search docs now emit meta.total_count (both previously dropped it). - schema tolerates a quoted multi-word command label; zero-state auth — and `link` with no profile — point at profile setup / the headless WEKNORA_KB_ID path instead of looping on `auth login`. - id-addressed reads tolerate a redundant --kb (doc view/wait, chunk list/view accept and ignore it, declared in schema) so a carried-over --kb doesn't exit 2; streaming commands warn that --jq does not apply to an NDJSON stream. - keep JSON-always as the default; --jq hints spell out the .data path. Consistency & gating: - doc create: drop the deprecated --name alias (--title only; pre-1.0 break). - chunk list --limit aligned to 1..10000; model list --limit/-L with has_more/total_count; api write-gates -X PUT/PATCH (exit 10); skills install expands a leading ~. - docs corrected: search docs / doc list --keyword help is case-insensitive (server does LOWER LIKE); AGENTS.md risk-action list (no phantom kb.init; add model.update / kb.config.set) and batch example (failed item carries `error`); session resume --message id comes from `message list`, not the stream. - auth/profile ergonomics: env credentials are now first-class — `auth token` prints the active WEKNORA_API_KEY / WEKNORA_TOKEN, and auth login/logout/refresh give an env-aware message instead of looping on "run auth login". `auth logout` clears credentials but keeps the profile registered (host preserved for re-login); deleting a profile is `profile remove`'s job (clean logout/remove separation, matching gh / lark). Config surface (symmetric read/write, in-place model edits): - kb config now returns a secret-free KBModelConfigView (was {}); `kb config` reads, new `kb config set` writes; `kb init` removed (misnomer). - kb create --chat-model: retrieval-ready in one step. - model update: edit a model in place (id preserved, references survive) — rotate --api-key-stdin, change base-url / display-name / etc. - session continue-stream renamed to session resume. Docs: AGENTS.md is the single wire-contract source; CHANGELOG slimmed; stale kb-init / continue-stream references removed; skill wire-vocab guard extended. AGENTS.md / weknora-shared SKILL document retrieval_ready (a KB needs an embedding model to be searchable), that --jq does not apply to NDJSON streams, and the env-credential-first auth path; the KB quickstart example now creates a retrieval-ready KB.
2026-07-02 07:53:51 +00:00
// A KB with no embedding model can hold documents but never index/retrieve
// them — surface the next step at the point of creation instead of leaving
// the agent to discover a silent-draft KB via a later empty search.
var meta *output.Meta
if created.EmbeddingModelID == "" {
meta = &output.Meta{Hint: "retrieval_ready=false: no embedding model bound. Uploaded docs will not be searchable until you run `weknora kb config set " + created.ID + " --embedding-model <id> --chat-model <id>` (create the KB with --embedding-model/--chat-model to skip this step)."}
}
feat(cli): --format / NDJSON / chat & agent invoke / MCP / SetAgentHelp / signal-aware ctx / kb create --storage-provider Adds the structured-output and agent-help surface plus root-level signal handling so AI agents (and humans working through pipes) get a stable wire contract. * --format text|json|ndjson flag, registered per-command on outputs that need it; default text on TTY, json on pipe. --jq <expr> pairs with json / ndjson to filter or project. FormatOptions absorbs JQ; WantsJSON() helper for the JSON dispatch. * WriteNDJSON helper in internal/format/ (per ndjson.org: one JSON value per line, arrays split element-per-line, empty slice → zero bytes). * chat / agent invoke wire --format ndjson via SDK StreamResponse / AgentStreamResponse 1:1 passthrough. Both commands detect ctx.Cancelled in every stream + session-create path and emit a stable "operation.cancelled" code on Ctrl-C / SIGTERM. * main.go wires signal.NotifyContext(SIGINT, SIGTERM) into the root context so long-running commands run their cancellation cleanup (re-emit auto-created session id, etc); the process exits 130 when the context was signal-cancelled, matching Unix convention. * MCP chat / agent_invoke output schemas extended with thinking / tool_calls / assistant_message_id (server-side accumulated; MCP tools/call has no standard partial-response). doc_view and doc_download now use doc_id (not knowledge_id) so agents see a single id naming convention across all tools — matches the chunk_list / search_chunks schemas and the CLI's <doc-id> positional. * SetAgentHelp(cmd, AgentHelp{...}) — opt-in machine-friendly --help payload activated by WEKNORA_AGENT_HELP=1. Applied to chat / kb list. * kb create --storage-provider <local|minio|cos|tos|s3|oss|ks3> — sets the new KB's storage_provider_config.provider at creation time (server does not expose it on update). Required on self-hosted deployments where the server-side default doesn't pre-populate a provider — without it, subsequent doc upload returns a misleading "kb not found".
2026-05-17 17:37:47 +00:00
if fopts.WantsJSON() {
feat(cli)!: v0.10 reliability, agent-UX, and command-surface hardening A hardening + finalization pass over the agent-first CLI: correctness fixes, richer machine-readable signals, flag/naming consistency, and a symmetric config surface. Pre-1.0, so it includes breaking renames. Correctness: - agent update: resolve/validate --model/--rerank-model (was storing a bogus name verbatim, corrupting config.model_id). - doctor: honor WEKNORA_HOST / WEKNORA_API_KEY (headless path no longer reports "no host configured"). - session ask / MCP session_ask: text answer was empty on non-TTY — the agent stream sets Done=true on an intermediate agent_query frame before the answer, and AgentAccumulator treated the first Done as terminal. Terminate on the `complete` event (new sdk.AgentResponseTypeComplete), not a per-frame Done. - batch exit codes: any per-item failure collapses to operation.failed (exit 1), including `doc upload --recursive` partial failures — a permanent per-file failure (e.g. a duplicate) no longer surfaces as a retryable exit 7 an agent would loop on; per-item typed errors stay in the envelope. Agent-first signals & discovery: - error.exit_code in the envelope (type + exit_code disambiguate the input.invalid_argument exit-2-vs-5 split in one JSON read). - meta.hint on empty content search and on draft doc create; doc wait fails fast on a never-parsing draft instead of hanging to --timeout. - retrieval-readiness is visible in the natural flow: kb status / kb check emit retrieval_ready, and kb create hints the fix when no embedding model is bound — an unconfigured KB no longer looks silently healthy. - schema contract completeness: every leaf declares output + >=1 example (drift-guarded); output strings match the meta actually emitted; chunk list and search docs now emit meta.total_count (both previously dropped it). - schema tolerates a quoted multi-word command label; zero-state auth — and `link` with no profile — point at profile setup / the headless WEKNORA_KB_ID path instead of looping on `auth login`. - id-addressed reads tolerate a redundant --kb (doc view/wait, chunk list/view accept and ignore it, declared in schema) so a carried-over --kb doesn't exit 2; streaming commands warn that --jq does not apply to an NDJSON stream. - keep JSON-always as the default; --jq hints spell out the .data path. Consistency & gating: - doc create: drop the deprecated --name alias (--title only; pre-1.0 break). - chunk list --limit aligned to 1..10000; model list --limit/-L with has_more/total_count; api write-gates -X PUT/PATCH (exit 10); skills install expands a leading ~. - docs corrected: search docs / doc list --keyword help is case-insensitive (server does LOWER LIKE); AGENTS.md risk-action list (no phantom kb.init; add model.update / kb.config.set) and batch example (failed item carries `error`); session resume --message id comes from `message list`, not the stream. - auth/profile ergonomics: env credentials are now first-class — `auth token` prints the active WEKNORA_API_KEY / WEKNORA_TOKEN, and auth login/logout/refresh give an env-aware message instead of looping on "run auth login". `auth logout` clears credentials but keeps the profile registered (host preserved for re-login); deleting a profile is `profile remove`'s job (clean logout/remove separation, matching gh / lark). Config surface (symmetric read/write, in-place model edits): - kb config now returns a secret-free KBModelConfigView (was {}); `kb config` reads, new `kb config set` writes; `kb init` removed (misnomer). - kb create --chat-model: retrieval-ready in one step. - model update: edit a model in place (id preserved, references survive) — rotate --api-key-stdin, change base-url / display-name / etc. - session continue-stream renamed to session resume. Docs: AGENTS.md is the single wire-contract source; CHANGELOG slimmed; stale kb-init / continue-stream references removed; skill wire-vocab guard extended. AGENTS.md / weknora-shared SKILL document retrieval_ready (a KB needs an embedding model to be searchable), that --jq does not apply to NDJSON streams, and the env-credential-first auth path; the KB quickstart example now creates a retrieval-ready KB.
2026-07-02 07:53:51 +00:00
return fopts.Emit(iostreams.IO.Out, created, meta)
}
fmt.Fprintf(iostreams.IO.Out, "✓ Created knowledge base %q (id: %s)\n", created.Name, created.ID)
feat(cli)!: v0.10 reliability, agent-UX, and command-surface hardening A hardening + finalization pass over the agent-first CLI: correctness fixes, richer machine-readable signals, flag/naming consistency, and a symmetric config surface. Pre-1.0, so it includes breaking renames. Correctness: - agent update: resolve/validate --model/--rerank-model (was storing a bogus name verbatim, corrupting config.model_id). - doctor: honor WEKNORA_HOST / WEKNORA_API_KEY (headless path no longer reports "no host configured"). - session ask / MCP session_ask: text answer was empty on non-TTY — the agent stream sets Done=true on an intermediate agent_query frame before the answer, and AgentAccumulator treated the first Done as terminal. Terminate on the `complete` event (new sdk.AgentResponseTypeComplete), not a per-frame Done. - batch exit codes: any per-item failure collapses to operation.failed (exit 1), including `doc upload --recursive` partial failures — a permanent per-file failure (e.g. a duplicate) no longer surfaces as a retryable exit 7 an agent would loop on; per-item typed errors stay in the envelope. Agent-first signals & discovery: - error.exit_code in the envelope (type + exit_code disambiguate the input.invalid_argument exit-2-vs-5 split in one JSON read). - meta.hint on empty content search and on draft doc create; doc wait fails fast on a never-parsing draft instead of hanging to --timeout. - retrieval-readiness is visible in the natural flow: kb status / kb check emit retrieval_ready, and kb create hints the fix when no embedding model is bound — an unconfigured KB no longer looks silently healthy. - schema contract completeness: every leaf declares output + >=1 example (drift-guarded); output strings match the meta actually emitted; chunk list and search docs now emit meta.total_count (both previously dropped it). - schema tolerates a quoted multi-word command label; zero-state auth — and `link` with no profile — point at profile setup / the headless WEKNORA_KB_ID path instead of looping on `auth login`. - id-addressed reads tolerate a redundant --kb (doc view/wait, chunk list/view accept and ignore it, declared in schema) so a carried-over --kb doesn't exit 2; streaming commands warn that --jq does not apply to an NDJSON stream. - keep JSON-always as the default; --jq hints spell out the .data path. Consistency & gating: - doc create: drop the deprecated --name alias (--title only; pre-1.0 break). - chunk list --limit aligned to 1..10000; model list --limit/-L with has_more/total_count; api write-gates -X PUT/PATCH (exit 10); skills install expands a leading ~. - docs corrected: search docs / doc list --keyword help is case-insensitive (server does LOWER LIKE); AGENTS.md risk-action list (no phantom kb.init; add model.update / kb.config.set) and batch example (failed item carries `error`); session resume --message id comes from `message list`, not the stream. - auth/profile ergonomics: env credentials are now first-class — `auth token` prints the active WEKNORA_API_KEY / WEKNORA_TOKEN, and auth login/logout/refresh give an env-aware message instead of looping on "run auth login". `auth logout` clears credentials but keeps the profile registered (host preserved for re-login); deleting a profile is `profile remove`'s job (clean logout/remove separation, matching gh / lark). Config surface (symmetric read/write, in-place model edits): - kb config now returns a secret-free KBModelConfigView (was {}); `kb config` reads, new `kb config set` writes; `kb init` removed (misnomer). - kb create --chat-model: retrieval-ready in one step. - model update: edit a model in place (id preserved, references survive) — rotate --api-key-stdin, change base-url / display-name / etc. - session continue-stream renamed to session resume. Docs: AGENTS.md is the single wire-contract source; CHANGELOG slimmed; stale kb-init / continue-stream references removed; skill wire-vocab guard extended. AGENTS.md / weknora-shared SKILL document retrieval_ready (a KB needs an embedding model to be searchable), that --jq does not apply to NDJSON streams, and the env-credential-first auth path; the KB quickstart example now creates a retrieval-ready KB.
2026-07-02 07:53:51 +00:00
if meta != nil {
fmt.Fprintf(iostreams.IO.Out, "⚠ %s\n", meta.Hint)
}
return nil
}