WeKnora/cli/internal/format/ndjson.go

26 lines
723 B
Go
Raw Normal View History

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
package format
import (
"io"
"reflect"
)
// WriteNDJSON serializes v as NDJSON: one JSON value per line, '\n' terminated.
// If v is a slice or array, each element gets its own line; otherwise v is
// emitted as a single line. Per http://ndjson.org.
//
// HTML escaping is disabled (via WriteJSON) so '<', '>', '&' stay literal —
// cleaner for agent stream-parsers that don't need HTML-safe output.
func WriteNDJSON(w io.Writer, v any) error {
rv := reflect.ValueOf(v)
if rv.IsValid() && (rv.Kind() == reflect.Slice || rv.Kind() == reflect.Array) {
for i := 0; i < rv.Len(); i++ {
if err := WriteJSON(w, rv.Index(i).Interface()); err != nil {
return err
}
}
return nil
}
return WriteJSON(w, v)
}