d3c03b2f34
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.
167 lines
6.2 KiB
Go
167 lines
6.2 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"
|
|
)
|
|
|
|
type AddOptions struct {
|
|
Host string
|
|
User string
|
|
Use bool // --use: switch to this profile after adding
|
|
DryRun bool
|
|
}
|
|
|
|
// profileAddFields enumerates the fields surfaced for `--format json` discovery on
|
|
// `profile add`. The result describes the newly-registered profile.
|
|
var profileAddFields = []string{
|
|
"name", "host", "user", "current",
|
|
}
|
|
|
|
// addResult is the typed payload emitted under data on success.
|
|
type addResult struct {
|
|
Name string `json:"name"`
|
|
Host string `json:"host"`
|
|
User string `json:"user,omitempty"`
|
|
Current bool `json:"current"`
|
|
}
|
|
|
|
// NewCmdAdd builds `weknora profile add`. Registers a *credentialless*
|
|
// connection target - host + optional user only. Credentials for the new
|
|
// profile are attached separately by making it active and running
|
|
// `weknora auth login`, separating "where" the CLI talks to (the host) and
|
|
// "how" it authenticates (the credential). Pass --use to switch to the new
|
|
// profile immediately, then run `weknora auth login`.
|
|
func NewCmdAdd(f *cmdutil.Factory) *cobra.Command {
|
|
opts := &AddOptions{}
|
|
cmd := &cobra.Command{
|
|
Use: "add <name>",
|
|
Short: "Register a new profile (host without credentials)",
|
|
Long: `Add a new profile entry to config.yaml. Stores host (and optionally
|
|
user) but does NOT prompt for credentials. To attach credentials, make the
|
|
profile active (` + "`weknora profile use <n>`" + `, or ` + "`profile add <n> --use`" + `) and run
|
|
` + "`weknora auth login`" + `.
|
|
|
|
The first profile added is auto-selected as the current profile. Subsequent
|
|
adds leave the current profile untouched unless --use is passed.`,
|
|
Example: ` weknora profile add staging --host https://staging.example.com
|
|
weknora profile add prod --host https://prod.example.com --user alice@example.com
|
|
weknora profile add prod --host https://prod.example.com --use # switch to it now`,
|
|
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())
|
|
// Pure-local validation runs before the dry-run gate so --dry-run
|
|
// rejects identically to the live path. Same typed errors as runAdd
|
|
// (kept there for direct-call callers).
|
|
name := args[0]
|
|
if err := cmdutil.ValidateProfileName(name); err != nil {
|
|
return err
|
|
}
|
|
host, err := cmdutil.NormalizeHost(opts.Host)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
cfg, err := config.Load()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if _, exists := cfg.Profiles[name]; exists {
|
|
return &cmdutil.Error{
|
|
Code: cmdutil.CodeResourceAlreadyExists,
|
|
Message: fmt.Sprintf("profile %q already exists", name),
|
|
Hint: fmt.Sprintf("use a different name, or run `weknora profile remove %s` first", name),
|
|
}
|
|
}
|
|
if handled, err := cmdutil.HandleDryRun(c, opts.DryRun, cmdutil.DryRunPlan{
|
|
Action: "profile.add",
|
|
Args: map[string]any{
|
|
"name": name,
|
|
"host": host,
|
|
},
|
|
}); handled {
|
|
return err
|
|
}
|
|
return runAddWithConfig(opts, fopts, name, host, cfg)
|
|
},
|
|
}
|
|
cmd.Flags().StringVar(&opts.Host, "host", "", "Server base URL, e.g. https://kb.example.com (required)")
|
|
cmd.Flags().StringVar(&opts.User, "user", "", "Account email shown in 'profile list' (optional, cosmetic only)")
|
|
cmd.Flags().BoolVar(&opts.Use, "use", false, "Switch to this profile after adding it")
|
|
cmdutil.AddFormatFlag(cmd, profileAddFields...)
|
|
cmdutil.AddDryRunFlag(cmd, &opts.DryRun)
|
|
_ = cmd.MarkFlagRequired("host")
|
|
cmdutil.SetAgentHelp(cmd, cmdutil.AgentHelp{
|
|
UsedFor: "Register a new profile (connection target) with a name and host URL. Does not store credentials; make it active (--use, or `profile use <n>`) and run `auth login` afterwards to authenticate.",
|
|
RequiredFlags: []string{"<name> (positional)", "--host"},
|
|
Output: "envelope.data has name, host, user, current",
|
|
Examples: []string{
|
|
"weknora profile add prod --host https://kb.example.com --use",
|
|
},
|
|
})
|
|
return cmd
|
|
}
|
|
|
|
// runAdd is the legacy direct-call entrypoint: revalidates inputs and loads
|
|
// config. Preserved for tests / external callers that bypass the cobra layer.
|
|
// The cobra RunE path validates earlier and delegates to runAddWithConfig.
|
|
func runAdd(opts *AddOptions, fopts *cmdutil.FormatOptions, name string) error {
|
|
if err := cmdutil.ValidateProfileName(name); err != nil {
|
|
return err
|
|
}
|
|
host, err := cmdutil.NormalizeHost(opts.Host)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
cfg, err := config.Load()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if _, exists := cfg.Profiles[name]; exists {
|
|
return &cmdutil.Error{
|
|
Code: cmdutil.CodeResourceAlreadyExists,
|
|
Message: fmt.Sprintf("profile %q already exists", name),
|
|
Hint: fmt.Sprintf("use a different name, or run `weknora profile remove %s` first", name),
|
|
}
|
|
}
|
|
return runAddWithConfig(opts, fopts, name, host, cfg)
|
|
}
|
|
|
|
// runAddWithConfig performs the side-effectful write. Inputs are assumed to be
|
|
// pre-validated (ValidateProfileName, NormalizeHost, dup-check) by the caller.
|
|
func runAddWithConfig(opts *AddOptions, fopts *cmdutil.FormatOptions, name, host string, cfg *config.Config) error {
|
|
if cfg.Profiles == nil {
|
|
cfg.Profiles = map[string]config.Profile{}
|
|
}
|
|
cfg.Profiles[name] = config.Profile{Host: host, User: opts.User}
|
|
wasFirst := cfg.CurrentProfile == ""
|
|
// The first profile is auto-selected; --use forces selection even when
|
|
// another profile is already current.
|
|
current := wasFirst || opts.Use
|
|
if current {
|
|
cfg.CurrentProfile = name
|
|
}
|
|
if err := config.Save(cfg); err != nil {
|
|
return cmdutil.Wrapf(cmdutil.CodeLocalFileIO, err, "save config")
|
|
}
|
|
|
|
if fopts.WantsJSON() {
|
|
return fopts.Emit(iostreams.IO.Out, addResult{Name: name, Host: host, User: opts.User, Current: current}, nil)
|
|
}
|
|
if current {
|
|
fmt.Fprintf(iostreams.IO.Out, "✓ Added profile %s (now current). Run `weknora auth login` to attach credentials.\n", name)
|
|
} else {
|
|
fmt.Fprintf(iostreams.IO.Out, "✓ Added profile %s. Run `weknora profile use %s` then `weknora auth login` to attach credentials.\n", name, name)
|
|
}
|
|
return nil
|
|
}
|