7bccd72ba3
Brings search docs and search sessions to v0.4 pagination canon (--limit / --page-size / --all-pages, matching session list / doc list). Both default --all-pages=true to preserve prior silent walk-all behavior; explicit knobs added for users who want one-page fetch. cli/AGENTS.md gains two new sections: - Command surface design SOP — a 5-step SDK-schema-first pre-design checklist for future contributors. Earlier spec drafts produced schema-error classes (missing/mismatched fields, missing pagination flags) when commands were designed from convention rather than from the SDK; the SOP makes the SDK the ground truth. - CRUD command flag canon — Mode A (hard-required + flag error, no interactive prompts), the established pattern for non-auth CRUD. Also fixes the agent invoke rationale source: the CLI-layer precedent for invoke being a separate verb (not a chat mode) is documented inline rather than referencing other vendor CLI behavior.
7.3 KiB
7.3 KiB
Changelog — weknora CLI
All notable changes to the weknora CLI (the binary under cli/ in this
repository) will be documented in this file.
The format follows Keep a Changelog and the CLI follows Semantic Versioning independently of the WeKnora server / frontend release cadence.
CLI history before v0.3 is recorded in the project root CHANGELOG.md under the release that introduced the CLI.
[Unreleased]
v0.5 — agent CRUD, chunk subtree, MCP chunk_list, audit-driven cleanup
Added
weknora agent create <name> --model <id>/agent edit <id>/agent delete <id>— hybrid surface (8 hot-path flags +--config-fileYAML/JSON tail +--generate-skeletontemplate emit).--from <agent-id>copies from an existing agent.weknora chunk list --doc <doc-id>/chunk view <chunk-id>/chunk delete <chunk-id> --doc <doc-id>— new subtree for RAG retrieval debug. Paginated with v0.4--limit/--page-size/--all-pagescanon.weknora mcp serveaddschunk_listas the 10th curated tool.weknora agent view <id>human output now renders all 34 AgentConfig fields (previously 7), grouped into 10 presentation sections.--all-pages/--page-sizeonsearch docsandsearch sessions(catching up withsession list/doc listcanon from v0.3+v0.4).
Fixed
- MCP
search_chunkstool:limitarg now correctly threads intoSearchParams.MatchCount. Previously the server's default cap won, silently capping below the requested limit. search sessionshuman time format: now usesfuzzyTimelikesession listinstead of raw RFC3339.
Changed
cli/AGENTS.mdMCP curation rationale rewritten: curated read-only is a deliberate product call gated on server-side token scope, not MCP industry canon.cli/AGENTS.mdadds §"Command surface design SOP" and §"CRUD command flag canon" for v0.6+ contributors.cli/go.mod: addsgopkg.in/yaml.v3foragent create --config-file.
v0.4 — output contract hardening and mainstream alignment
Breaking changes
- Dropped the JSON envelope.
stdoutnow emits bare typed data ({...}or[...]); errors are written tostderrascode: msgwith an actionablehint:line. Pipelines using--json | jqno longer have to filter out an envelope wrapper. - Dropped
--dry-run. Destructive writes still require-y/--yes; non-TTY callers that omit-yexit with code 10 andinput.confirmation_requiredso an agent must surface the prompt to a human before retrying. - Dropped the per-command AI footer that rendered when
CLAUDECODEorCURSOR_AGENTwas set. The same machine-readable guidance now lives in the standard--help(visible to all callers) and inmcp serve's tool descriptions.
Added
weknora mcp serve— curated read-only stdio MCP server exposing 9 tools (kb_list,kb_view,doc_list,doc_view,doc_download,search_chunks,chat,agent_list,agent_invoke). Destructive verbs are intentionally excluded.weknora agent list/agent view/agent invoke— manage and call WeKnora's server-side Custom Agent resources.weknora auth token— print the active credential tostdoutfor scripting (raw secret by default;--jsonemits{token, mode, context}).weknora doc upload --from-url— ingest a remote URL.--json=fields,...field projection and--jq <expr>filtering on every command that emits JSON.--limitand--all-pageson list / search commands for bounded output and explicit pagination control.- Per-resource filter flags:
kb list --pinned,doc list --status,session list --since.
Changed
- Go toolchain bumped from 1.24 to 1.26.
auth login --with-tokenvalidates the supplied key against/auth/mebefore persisting, and prints an advisory if the keyring is unavailable and credentials fall back to a 0600 file under$XDG_CONFIG_HOME/weknora/secrets/.- AGENTS.md rewritten as a developer guide (~170 lines, 6 H2 sections).
v0.3 — extended management surface and a session subtree
Added
context add/context list/context remove— first-class CRUD over connection targets (previously implicit viaauth login --name). Removing the current context requires explicit-y(exit-10 protocol) because subsequent commands have no default target.auth refresh— exchanges the stored refresh token for a new access + refresh pair (OAuth refresh-token grant). Transparent 401 → refresh → retry is also wired into the SDK transport with singleflight de-dup, so most callers never need to invoke this explicitly.kb edit— partial-update edit with only-sent-fields semantics (*stringoptions so unset fields stay unset in the PUT body).kb pin/kb unpin— idempotent pin/unpin toggle; no-op when already in the target state (emits_meta.warnings, no server call).kb empty— bulk-delete documents while preserving the KB record and its config. High-risk-write; exit-10 confirmation in non-TTY /--jsonpaths.doc view <id>— show one document's metadata (title, file name, type, size, parse status, embedding model, processed-at, error message). Counterpart tokb viewandsession view.doc download— stream a knowledge file to disk (-O FILE/-O -for stdout) with--clobbercontrolling overwrite. Rejects server-supplied path-like filenames; partial writes on error are cleaned up.doc upload --recursive --glob '*.md'— walk a directory and upload every match. Per-fileOK/FAILprogress lines on the human path; aggregateduploaded[]/failed[]envelope on--json. Exit code typed to the first failure's class on partial failure.search chunks/search kb/search docs/search sessions— verb-noun subtree (ghsearch code/repos/issues/…shape).search chunksis hybrid (vector + keyword) retrieval; the other three are client-side substring filters useful for discovering identifiers. All four take--limit N/-L N(1..1000) to cap returned rows.session list/session view/session delete— chat session management.api --input FILE/api --input -— body source for raw HTTP passthrough (file or stdin); mutually exclusive with--data.unlink— remove the cwd's.weknora/project.yamlso subsequent commands stop auto-resolving--kbfrom it. Walks up from cwd so a user in a subdirectory can unlink without cd-ing to the project root (mirrorsvercel unlink/netlify unlink).- Completion smoke test guards against cobra bumps silently breaking bash / zsh / fish / powershell completion.
SDK additions (Go client at client/, strictly additive)
OpenKnowledgeFile(ctx, id) (filename, body io.ReadCloser, err)— new primitive returning the body as a stream plus the server-suggested Content-Disposition filename.DownloadKnowledgeFileis now a thin wrapper (signature unchanged, gained partial-file-on-error cleanup).WithTransport(http.RoundTripper) ClientOption— lets the CLI install the 401-retry transport.PathAuthLogin/PathAuthRefreshconstants — so HTTP middleware doesn't re-hardcode the literals.IsPinned boolfield onKnowledgeBase(server already returned it; SDK just hadn't modeled it).