mirror of
https://github.com/Tencent/WeKnora.git
synced 2026-11-02 05:03:00 +08:00
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.
163 lines
5.7 KiB
Go
163 lines
5.7 KiB
Go
package profilecmd
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
|
"github.com/Tencent/WeKnora/cli/internal/config"
|
|
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
|
"github.com/Tencent/WeKnora/cli/internal/prompt"
|
|
"github.com/Tencent/WeKnora/cli/internal/secrets"
|
|
)
|
|
|
|
type RemoveOptions struct {
|
|
Yes bool // sourced from the global -y/--yes persistent flag (matches `kb delete`)
|
|
DryRun bool
|
|
}
|
|
|
|
// profileRemoveFields enumerates the fields surfaced for `--format json` discovery on
|
|
// `profile remove`. The result reports the disposition of the removed entry.
|
|
var profileRemoveFields = []string{
|
|
"name", "removed", "was_current",
|
|
}
|
|
|
|
// removeResult is the typed payload emitted under data on success.
|
|
type removeResult struct {
|
|
Name string `json:"name"`
|
|
Removed bool `json:"removed"`
|
|
WasCurrent bool `json:"was_current"`
|
|
}
|
|
|
|
// NewCmdRemove builds `weknora profile remove`. Drops the entry from
|
|
// config.yaml and best-effort clears keyring references. Removing a
|
|
// non-current profile is low-friction (no prompt). Removing the *current*
|
|
// profile triggers the destructive-write confirmation protocol (exit 10),
|
|
// because subsequent commands will have no default connection target.
|
|
func NewCmdRemove(f *cmdutil.Factory) *cobra.Command {
|
|
opts := &RemoveOptions{}
|
|
cmd := &cobra.Command{
|
|
Use: "remove <name>",
|
|
Short: "Remove a profile (drops entry, clears keyring refs)",
|
|
Long: `Deletes the named profile from config.yaml and best-effort clears any
|
|
keyring references it owned (matches ` + "`weknora auth logout`" + `).
|
|
|
|
Removing the current profile also clears CurrentProfile - subsequent commands
|
|
will error until you select another with ` + "`weknora profile use <name>`" + ` or pick
|
|
one up via the global ` + "`--profile`" + ` flag. Because that change is observable in
|
|
every later command, removing the current profile requires explicit -y/--yes
|
|
in scripted / --format json invocations (exit code 10; see cli/README.md).`,
|
|
Example: ` weknora profile remove staging # remove non-current → no prompt
|
|
weknora profile remove production -y # remove current → confirm`,
|
|
Args: cobra.ExactArgs(1),
|
|
RunE: func(c *cobra.Command, args []string) error {
|
|
fopts, err := cmdutil.CheckFormatFlag(c)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
fopts.ResolveDefault(iostreams.IO.IsStdoutTTY())
|
|
opts.Yes, _ = c.Flags().GetBool("yes")
|
|
// Pure-local existence check runs before the dry-run gate so
|
|
// --dry-run rejects unknown profile names identically to the live
|
|
// path. Same notFoundError as runRemove (kept there for direct
|
|
// callers).
|
|
cfg, cfgErr := config.Load()
|
|
if cfgErr != nil {
|
|
return cfgErr
|
|
}
|
|
if _, exists := cfg.Profiles[args[0]]; !exists {
|
|
return notFoundError(args[0], cfg)
|
|
}
|
|
if handled, err := cmdutil.HandleDryRun(c, opts.DryRun, cmdutil.DryRunPlan{
|
|
Action: "profile.remove",
|
|
Args: map[string]any{
|
|
"name": args[0],
|
|
},
|
|
}); handled {
|
|
return err
|
|
}
|
|
store, err := f.Secrets()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return runRemove(opts, fopts, args[0], store, f.Prompter())
|
|
},
|
|
}
|
|
cmdutil.AddFormatFlag(cmd, profileRemoveFields...)
|
|
cmdutil.AddDryRunFlag(cmd, &opts.DryRun)
|
|
cmdutil.SetRisk(cmd, "profile.remove")
|
|
cmdutil.SetAgentHelp(cmd, cmdutil.AgentHelp{
|
|
UsedFor: "remove a named profile and its stored credentials",
|
|
RequiredFlags: []string{"<name> (positional)"},
|
|
Output: "envelope.data is {name, removed:true, was_current}",
|
|
Examples: []string{
|
|
"weknora profile remove staging",
|
|
"weknora profile remove production -y",
|
|
},
|
|
Warnings: []string{
|
|
"Requires explicit user approval (exit 10 / input.confirmation_required); never auto-add -y.",
|
|
"profile remove deletes local credentials + config; the server-side token is not revoked (use 'auth logout' on server instead).",
|
|
},
|
|
})
|
|
return cmd
|
|
}
|
|
|
|
func runRemove(opts *RemoveOptions, fopts *cmdutil.FormatOptions, name string, store secrets.Store, p prompt.Prompter) error {
|
|
cfg, err := config.Load()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
ctx, exists := cfg.Profiles[name]
|
|
if !exists {
|
|
return notFoundError(name, cfg)
|
|
}
|
|
wasCurrent := name == cfg.CurrentProfile
|
|
|
|
jsonOut := fopts.WantsJSON()
|
|
// Confirmation only fires for removing the current profile - non-current
|
|
// remove uses the same low-friction policy as `auth logout`.
|
|
if wasCurrent {
|
|
if err := cmdutil.ConfirmDestructive(p, opts.Yes, jsonOut, "remove", "current profile", name, "profile.remove", []string{"weknora", "profile", "remove", name, "-y"}); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
// Config first, secrets after: a crash in between leaves an orphan
|
|
// keyring entry but no dangling config ref (same ordering as auth logout).
|
|
delete(cfg.Profiles, name)
|
|
if wasCurrent {
|
|
cfg.CurrentProfile = ""
|
|
}
|
|
if err := config.Save(cfg); err != nil {
|
|
return cmdutil.Wrapf(cmdutil.CodeLocalFileIO, err, "save config")
|
|
}
|
|
clearProfileSecrets(store, ctx, name)
|
|
|
|
result := removeResult{Name: name, Removed: true, WasCurrent: wasCurrent}
|
|
if jsonOut {
|
|
return fopts.Emit(iostreams.IO.Out, result, nil)
|
|
}
|
|
if wasCurrent {
|
|
fmt.Fprintf(iostreams.IO.Out, "✓ Removed profile %s (current profile cleared - run `weknora profile use <name>` to pick another)\n", name)
|
|
} else {
|
|
fmt.Fprintf(iostreams.IO.Out, "✓ Removed profile %s\n", name)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// clearProfileSecrets mirrors auth/logout.go: best-effort delete every secret
|
|
// slot the profile references. Errors are swallowed so a missing keyring
|
|
// entry doesn't block remove (same policy as `auth logout`).
|
|
func clearProfileSecrets(store secrets.Store, c config.Profile, name string) {
|
|
if c.TokenRef != "" {
|
|
_ = store.Delete(name, "access")
|
|
}
|
|
if c.RefreshRef != "" {
|
|
_ = store.Delete(name, "refresh")
|
|
}
|
|
if c.APIKeyRef != "" {
|
|
_ = store.Delete(name, "api_key")
|
|
}
|
|
}
|