docs(cli): README / AGENTS.md / CHANGELOG + CI parity test

Wire-contract documentation and the CI check that keeps it honest.

* cli/README.md gains a verbatim --help block (top-level + subtrees),
  an Exit codes table covering 0/1/2/3/4/5/6/7/10/124/130, a "Status
  vs check" verb-pair subtable, and a "doc wait" paragraph spelling out
  the four exit codes (0 / 1 / 124 / 130). The api passthrough note
  trims storage provider out of the deep-config list now that
  kb create --storage-provider is a polished flag.
* cli/AGENTS.md becomes the contributor guide: build/test, CRUD flag
  conventions, the status/check verb pattern, long-poll wait commands,
  the SetAgentHelp pattern, and a full Error code reference with 35
  typed codes mapped to namespaces, exit codes, retryable / hint
  guidance. Reference section is bracketed by HTML markers so a CI
  parity test can keep it in sync with AllCodes().
* cli/internal/cmdutil/errors_doc_test.go enforces parity: every code
  in AllCodes() must appear in AGENTS.md inside the markers, and
  AGENTS.md must not reference codes that no longer exist. Fails CI
  if a new typed code is added without documentation.
* CHANGELOG.md gets the v0.6 entry: BREAKING (--json / --no-stream /
  WEKNORA_SDK_DEBUG / kb create --name), Added (--format / --jq /
  doc wait / --log-level / kb-and-agent status & check / multi-id
  delete / api --paginate / MCP schema extension / SetAgentHelp /
  signal-aware ctx / kb create --storage-provider / new operation.*
  namespace), Changed (multi-id partial-failure exit code, doc upload
  FlagError, --log-level FlagError, multi-id stdout cleanup, README /
  AGENTS.md changes), with a Migration from v0.5 section walking
  every BREAKING through its v0.6 replacement.
This commit is contained in:
nullkey
2026-05-18 01:38:42 +08:00
committed by lyingbug
parent 34bb0b5096
commit 7611d59d71
9 changed files with 388 additions and 68 deletions
+8 -8
View File
@@ -46,7 +46,7 @@ func TestRAGFullLoop(t *testing.T) {
"XDG_CONFIG_HOME="+xdg,
"XDG_CACHE_HOME="+filepath.Join(xdg, "cache"),
// SDK debug off - explicit so the CI run isn't noisy.
"WEKNORA_SDK_DEBUG=",
"WEKNORA_LOG_LEVEL=error",
)
// 1. kb create → bare KnowledgeBase object
@@ -55,7 +55,7 @@ func TestRAGFullLoop(t *testing.T) {
ID string `json:"id"`
Name string `json:"name"`
}
runJSONInto(t, bin, env, &created, "kb", "create", "--name", kbName, "--json")
runJSONInto(t, bin, env, &created, "kb", "create", kbName, "--format", "json")
if created.ID == "" {
t.Fatalf("kb create returned no id")
}
@@ -63,7 +63,7 @@ func TestRAGFullLoop(t *testing.T) {
t.Cleanup(func() {
// Best-effort cleanup; a 404 means the KB was already gone.
out, err := run(bin, env, "kb", "delete", created.ID, "-y", "--json")
out, err := run(bin, env, "kb", "delete", created.ID, "-y", "--format", "json")
if err != nil {
t.Logf("cleanup kb delete: %v\n%s", err, out)
}
@@ -74,7 +74,7 @@ func TestRAGFullLoop(t *testing.T) {
var uploaded struct {
ID string `json:"id"`
}
runJSONInto(t, bin, env, &uploaded, "doc", "upload", docPath, "--kb", created.ID, "--json")
runJSONInto(t, bin, env, &uploaded, "doc", "upload", docPath, "--kb", created.ID, "--format", "json")
if uploaded.ID == "" {
t.Fatalf("doc upload returned no id")
}
@@ -85,18 +85,18 @@ func TestRAGFullLoop(t *testing.T) {
// 4. search chunks → bare []SearchResult
var results []map[string]any
runJSONInto(t, bin, env, &results, "search", "chunks", "sample", "--kb", created.ID, "--limit", "5", "--json")
runJSONInto(t, bin, env, &results, "search", "chunks", "sample", "--kb", created.ID, "--limit", "5", "--format", "json")
if len(results) == 0 {
t.Fatalf("search returned no results")
}
t.Logf("search returned %d results", len(results))
// 5. chat --no-stream --json → bare {answer, references, ...} object
// 5. chat --format json → bare {answer, references, ...} object
var chat struct {
Answer string `json:"answer"`
References []map[string]any `json:"references"`
}
runJSONInto(t, bin, env, &chat, "chat", "summarize the document briefly", "--kb", created.ID, "--no-stream", "--json")
runJSONInto(t, bin, env, &chat, "chat", "summarize the document briefly", "--kb", created.ID, "--format", "json")
if strings.TrimSpace(chat.Answer) == "" {
t.Fatalf("chat returned empty answer")
}
@@ -201,7 +201,7 @@ func waitDocReady(t *testing.T, bin string, env []string, kbID, docID string, ti
ID string `json:"id"`
ParseStatus string `json:"parse_status"`
}
runJSONInto(t, bin, env, &docs, "doc", "list", "--kb", kbID, "--page-size", "100", "--json")
runJSONInto(t, bin, env, &docs, "doc", "list", "--kb", kbID, "--page-size", "100", "--format", "json")
for _, d := range docs {
if d.ID != docID {
continue