mirror of
https://github.com/Tencent/WeKnora.git
synced 2026-11-01 20:52:50 +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.
184 lines
6.6 KiB
Go
184 lines
6.6 KiB
Go
package auth
|
|
|
|
import (
|
|
"fmt"
|
|
"os"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
|
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
|
)
|
|
|
|
// authTokenFields lists fields surfaced in `--help` as a hint for `--jq`
|
|
// projection. Single-resource shape: emits the bare token object directly.
|
|
var authTokenFields = []string{"token", "mode", "profile"}
|
|
|
|
type tokenResult struct {
|
|
Token string `json:"token"`
|
|
Mode string `json:"mode"` // ModeBearer (JWT) or ModeAPIKey
|
|
Profile string `json:"profile"`
|
|
}
|
|
|
|
// NewCmdToken builds `weknora auth token`. Prints the active profile's
|
|
// credential to stdout for use in shell pipelines, e.g.
|
|
//
|
|
// WEKNORA_TOKEN=$(weknora auth token)
|
|
// curl -H "Authorization: Bearer $WEKNORA_TOKEN" ... # JWT mode
|
|
// curl -H "X-API-Key: $WEKNORA_TOKEN" ... # api-key mode
|
|
//
|
|
// The user is responsible for constructing the appropriate header -
|
|
// `auth list` shows which mode each profile uses.
|
|
//
|
|
// Default output: raw token on stdout, no trailing newline (clean $(...)).
|
|
// `--format json[=fields]` emits a bare {token, mode, profile} object.
|
|
func NewCmdToken(f *cmdutil.Factory) *cobra.Command {
|
|
cmd := &cobra.Command{
|
|
Use: "token",
|
|
Short: "Print the active profile's credential to stdout",
|
|
Long: `Print the active profile's credential to stdout, with no trailing
|
|
newline, suitable for shell command substitution.
|
|
|
|
The credential is the long-lived API key (mode: api-key) or the access JWT
|
|
(mode: bearer), depending on how the profile was created. Run ` + "`weknora auth list`" + `
|
|
to see which mode each profile uses, and construct the matching HTTP header:
|
|
|
|
Authorization: Bearer <token> # bearer mode
|
|
X-API-Key: <token> # api-key mode
|
|
|
|
` + "`--profile <name>`" + ` (global flag) selects a non-active profile to read from.`,
|
|
Example: ` WEKNORA_TOKEN=$(weknora auth token)
|
|
weknora auth token --profile staging
|
|
weknora auth token --format json`,
|
|
Args: cobra.NoArgs,
|
|
RunE: func(c *cobra.Command, _ []string) error {
|
|
fopts, err := cmdutil.CheckFormatFlag(c)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
// `auth token` is a scalar scripting helper (WEKNORA_TOKEN=$(...)),
|
|
// so it defaults to the raw token — overriding the global json
|
|
// default, the same way `doc download` streams raw bytes. Explicit
|
|
// --format json / WEKNORA_FORMAT=json still emit the
|
|
// {token,mode,profile} envelope.
|
|
fopts.FromEnv()
|
|
if fopts.Mode == "" {
|
|
// --jq implies JSON (it filters the envelope); without it,
|
|
// default to the raw token for clean $(...) capture.
|
|
if fopts.JQ != "" {
|
|
fopts.Mode = cmdutil.FormatJSON
|
|
} else {
|
|
fopts.Mode = cmdutil.FormatText
|
|
}
|
|
}
|
|
return runToken(f, fopts)
|
|
},
|
|
}
|
|
cmdutil.AddFormatFlag(cmd, authTokenFields...)
|
|
cmdutil.SetAgentHelp(cmd, cmdutil.AgentHelp{
|
|
UsedFor: "print the active profile's raw credential to stdout for shell capture",
|
|
Examples: []string{
|
|
"WEKNORA_TOKEN=$(weknora auth token)",
|
|
"weknora auth token --profile staging",
|
|
"weknora auth token --format json",
|
|
},
|
|
Output: "raw token on stdout (no envelope, no trailing newline) by default; --format json emits {token, mode, profile}",
|
|
Warnings: []string{
|
|
"default output is the bare token, NOT the JSON envelope — it is a scripting helper for shell capture",
|
|
},
|
|
})
|
|
return cmd
|
|
}
|
|
|
|
func runToken(f *cmdutil.Factory, fopts *cmdutil.FormatOptions) error {
|
|
// Env credentials are the active credential on the headless path — `auth
|
|
// token` must surface them (they ARE the token / api key) instead of
|
|
// erroring on the absence of a stored profile.
|
|
if active, kind := cmdutil.EnvCredential(); active {
|
|
mode := ModeBearer
|
|
if kind == "WEKNORA_API_KEY" {
|
|
mode = ModeAPIKey
|
|
}
|
|
return emitToken(fopts, os.Getenv(kind), mode, "(env)")
|
|
}
|
|
cfg, err := f.Config()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
profileName := cfg.CurrentProfile
|
|
if f.ProfileOverride != "" {
|
|
profileName = f.ProfileOverride
|
|
}
|
|
if profileName == "" {
|
|
return cmdutil.NewError(cmdutil.CodeAuthUnauthenticated,
|
|
"no active profile configured")
|
|
}
|
|
ctx, ok := cfg.Profiles[profileName]
|
|
if !ok {
|
|
return cmdutil.NewError(cmdutil.CodeLocalProfileNotFound,
|
|
fmt.Sprintf("profile %q not found", profileName))
|
|
}
|
|
|
|
store, err := f.Secrets()
|
|
if err != nil {
|
|
return cmdutil.Wrapf(cmdutil.CodeLocalKeychainDenied, err, "init secrets store")
|
|
}
|
|
|
|
// Resolve the stored credential. Prefer bearer (JWT) when both refs
|
|
// are present - JWT is the more capable mode and what `buildClient`
|
|
// uses for the Authorization header (see factory.go buildClient).
|
|
var token, mode string
|
|
switch {
|
|
case ctx.TokenRef != "":
|
|
v, ferr := cmdutil.LoadSecret(store, profileName, "access")
|
|
if ferr != nil {
|
|
return ferr
|
|
}
|
|
token, mode = v, ModeBearer
|
|
case ctx.APIKeyRef != "":
|
|
v, ferr := cmdutil.LoadSecret(store, profileName, "api_key")
|
|
if ferr != nil {
|
|
return ferr
|
|
}
|
|
token, mode = v, ModeAPIKey
|
|
default:
|
|
return cmdutil.NewError(cmdutil.CodeAuthUnauthenticated,
|
|
fmt.Sprintf("profile %q has no stored credential; run `weknora auth login`", profileName))
|
|
}
|
|
|
|
if token == "" {
|
|
return cmdutil.NewError(cmdutil.CodeAuthUnauthenticated,
|
|
fmt.Sprintf("profile %q credential is empty in keyring; run `weknora auth login`", profileName))
|
|
}
|
|
|
|
return emitToken(fopts, token, mode, profileName)
|
|
}
|
|
|
|
// emitToken renders a resolved credential: the {token, mode, profile} envelope
|
|
// under --format json, else the raw token on stdout (no trailing newline, for
|
|
// clean $(weknora auth token) capture) with a TTY-only leak hint on stderr.
|
|
func emitToken(fopts *cmdutil.FormatOptions, token, mode, profile string) error {
|
|
if token == "" {
|
|
return cmdutil.NewError(cmdutil.CodeAuthUnauthenticated, "active credential is empty")
|
|
}
|
|
if fopts.WantsJSON() {
|
|
return fopts.Emit(iostreams.IO.Out, tokenResult{Token: token, Mode: mode, Profile: profile}, nil)
|
|
}
|
|
|
|
// No trailing newline - clean $(weknora auth token) substitution.
|
|
fmt.Fprint(iostreams.IO.Out, token)
|
|
// Defensive hint to stderr when stdout is an interactive terminal:
|
|
// the user likely didn't mean to display the secret on screen.
|
|
// stderr-only so scripts (always non-TTY) are unaffected. Mode-specific
|
|
// because api-key tokens are long-lived and rotation is the only
|
|
// recourse on leak - bearer tokens self-expire via refresh.
|
|
if iostreams.IO.IsStdoutTTY() {
|
|
fmt.Fprintln(iostreams.IO.Err)
|
|
fmt.Fprintln(iostreams.IO.Err, "hint: pipe to $(weknora auth token) to capture; this terminal scrollback now contains the secret")
|
|
if mode == ModeAPIKey {
|
|
fmt.Fprintln(iostreams.IO.Err, "note: api-key credentials are long-lived - rotate via your auth provider if exposed (no `auth refresh` path)")
|
|
}
|
|
}
|
|
return nil
|
|
}
|