35c79281c8
Final design-pass audit on the v0.3 surface flagged two real gaps. (A) doc view <id> was missing. Every other resource subtree exposes a view verb (kb view, session view) for inspecting a single record, but doc — which has the richest metadata of the three (title, file name, type, size, parse_status, embedding_model, processed_at, error_message) — had no single-doc surface. Users wanting one doc's metadata had to `doc list | grep`. Implementation mirrors kb view: narrow ViewService(GetKnowledge) interface, --json envelope path, human KEY: VALUE renderer. Optional fields are omitted rather than rendered as "-" so the panel is dense. Tested: human renderer, title fallback when FileName empty, omit-empty contract, JSON envelope shape, 404 classification. (B) link had no counterpart. Once .weknora/project.yaml is written, the only way to clear it was `rm` by hand. Both vercel and netlify ship `unlink` as a top-level verb; not having one was a discoverability gap. Top-level rather than `link --clear` follows the verb-noun convention of the rest of the surface — the verb stands alone and the operation isn't parameterised. unlink walks up from cwd via projectlink.Discover (the same parent-chain logic Factory.ResolveKB uses on the read side), so a user in a subdirectory of a linked project can unlink without cd-ing up. Errors with input.invalid_argument when no link is found anywhere in the chain. Idempotent under racy concurrent removal: os.ErrNotExist on os.Remove falls through to a Success envelope since the post-condition holds either way. projectlink package gained Remove() alongside Save / Load / Discover so unlink doesn't reimplement the idempotent-remove pattern inline. Top-level registration in cmd/root.go, alongside link. cli/AGENTS.md verb canon line adds unlink to the locally-introduced list. cli/CHANGELOG.md gains an Added entry for each. 5 unit tests for view + 4 for unlink (cwd / walk-up / no-link error / JSON envelope). Full suite green. Intentionally deferred: - session edit (rename a session): sessions auto-name from the first prompt; polish rather than a gap. - link --clear as an alternative to unlink: top-level unlink is the documented form; aliases would just multiply the surface.
71 lines
3.8 KiB
Markdown
71 lines
3.8 KiB
Markdown
# 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](https://keepachangelog.com/en/1.0.0/)
|
|
and the CLI follows [Semantic Versioning](https://semver.org/) independently
|
|
of the WeKnora server / frontend release cadence.
|
|
|
|
Earlier history (v0.0 through v0.2) is recorded in the project root
|
|
[CHANGELOG.md](../CHANGELOG.md) under the entries that introduced the CLI.
|
|
|
|
## [Unreleased]
|
|
|
|
### v0.3 — extended management surface and a `session` subtree
|
|
|
|
#### Added
|
|
- `context add` / `context list` / `context remove` — first-class CRUD over
|
|
connection targets (previously implicit via `auth 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
|
|
(`*string` options 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 / `--json`
|
|
paths; `--dry-run` emits `risk` + `dry_run:true`.
|
|
- `doc view <id>` — show one document's metadata (title, file name,
|
|
type, size, parse status, embedding model, processed-at, error
|
|
message). Counterpart to `kb view` and `session view`.
|
|
- `doc download` — stream a knowledge file to disk (`-O FILE` /
|
|
`-O -` for stdout) with `--clobber` controlling 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-file `OK` / `FAIL` progress lines on the human path;
|
|
aggregated `uploaded[]` / `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 (gh `search code/repos/issues/…` shape). `search
|
|
chunks` is 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.yaml` so subsequent
|
|
commands stop auto-resolving `--kb` from it. Walks up from cwd so a
|
|
user in a subdirectory can unlink without cd-ing to the project root
|
|
(mirrors `vercel 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. `DownloadKnowledgeFile` is 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` / `PathAuthRefresh` constants — so HTTP middleware
|
|
doesn't re-hardcode the literals.
|
|
- `IsPinned bool` field on `KnowledgeBase` (server already returned it;
|
|
SDK just hadn't modeled it).
|