ad150c7126
Sweep every CLI output path through the v0.7 envelope contract.
FormatOptions.Emit signature changes to (w, data, meta *output.Meta)
so list commands surface meta.count / has_more in the wire envelope.
TTY indent decision plumbed via FormatOptions.TTY (set by
ResolveDefault). --format and --jq promoted to persistent root flags
so unknown-subcommand paths still reach the typed-envelope guard
(per-command registration would have rejected --format on unknown
commands as cobra-prose exit 2). WEKNORA_FORMAT env-var fallback
honored before TTY-resolved default. AddFormatFlag retained for the
per-command --jq field-hint Long-text addendum.
~55 production Emit call sites swept across cli/cmd/**: list paths
populate meta.count; mutation paths pass nil meta; envelope.profile
threaded via globalProfile. Existing JSON-shape tests migrated to
decode the envelope wrapper.
Multi-target batch operations get a unified shape via new helpers:
- output.BatchItem + output.WriteBatchEnvelope (§4.5 per-item ok
pattern; data:[{id, ok, result?|error?}], meta:{count, successes*,
failures*}; Successes/Failures *int so explicit zero survives
omitempty in all-fail case).
- cmdutil.RunBatch + cmdutil.EmitBatch + cmdutil.DeletedAtNow +
cmdutil.ClassifyContextErr collapse the three previously-duplicated
multi-delete pipelines (doc / chunk / session) into one call site
pattern. doc upload --recursive uses the same helpers with a per-
file resultFn. Summary error sets Silent:true so the stderr
envelope path doesn't duplicate the stdout batch detail (exit 1
preserved via Code → ExitCode).
ConfirmDestructive / ConfirmDestructiveBatch extended with action +
retryCmd parameters. Every destructive command (kb delete, kb edit,
doc delete, doc delete --all, agent delete, agent edit, session
delete, chunk delete, auth logout, api -X DELETE) now attaches
error.risk.{level:"destructive", action:"<noun.verb>"} +
error.retry_command on the exit-10 envelope. kb edit / agent edit
also gain the destructive guard wiring (CHANGELOG listed them as
gated but they were silently executing without -y).
MCP tool handlers' 31 error paths return CallToolResult with
IsError + Content text fallback + StructuredContent (envelope.error
shape via cmdutil.ErrorToDetail). Handler Out type changed from
typed *sdk.X to any so the go-sdk auto-marshal doesn't overwrite
StructuredContent with a zero-struct on error returns. Success path
manually populates CallToolResult.StructuredContent via successResult
helper.
weknora api cleanup:
- -d/--data flag removed; body via --input <file> or --input -
(stdin) only. Aligns with gh / curl convention.
- HTTP method whitelist removed; any non-empty method accepted.
- HTTP Retry-After header → cmdutil.Error.RetryAfterSeconds →
envelope.error.retry_after_seconds.
- runAPIPaginated raw-passthrough fallback now wraps response in
envelope so --paginate never emits bare JSON to stdout.
Test sweep: ~60 cmd/** tests migrated to decode envelope shape.
9 wire-contract goldens updated under cli/acceptance/testdata/wire/.
Spec: docs/superpowers/specs/2026-05-20-weknora-cli-v0.7-design.md §4 / §5
137 lines
4.6 KiB
Go
137 lines
4.6 KiB
Go
package auth
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"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
|
|
}
|
|
fopts.ResolveDefault(iostreams.IO.IsStdoutTTY())
|
|
return runToken(f, fopts)
|
|
},
|
|
}
|
|
cmdutil.AddFormatFlag(cmd, authTokenFields...)
|
|
return cmd
|
|
}
|
|
|
|
func runToken(f *cmdutil.Factory, fopts *cmdutil.FormatOptions) error {
|
|
cfg, err := f.Config()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
ctxName := cfg.CurrentContext
|
|
if f.ProfileOverride != "" {
|
|
ctxName = f.ProfileOverride
|
|
}
|
|
if ctxName == "" {
|
|
return cmdutil.NewError(cmdutil.CodeAuthUnauthenticated,
|
|
"no current profile configured")
|
|
}
|
|
ctx, ok := cfg.Contexts[ctxName]
|
|
if !ok {
|
|
return cmdutil.NewError(cmdutil.CodeLocalProfileNotFound,
|
|
fmt.Sprintf("profile %q not found", ctxName))
|
|
}
|
|
|
|
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, ctxName, "access")
|
|
if ferr != nil {
|
|
return ferr
|
|
}
|
|
token, mode = v, ModeBearer
|
|
case ctx.APIKeyRef != "":
|
|
v, ferr := cmdutil.LoadSecret(store, ctxName, "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`", ctxName))
|
|
}
|
|
|
|
if token == "" {
|
|
return cmdutil.NewError(cmdutil.CodeAuthUnauthenticated,
|
|
fmt.Sprintf("profile %q credential is empty in keyring; run `weknora auth login`", ctxName))
|
|
}
|
|
|
|
if fopts.WantsJSON() {
|
|
return fopts.Emit(iostreams.IO.Out, tokenResult{Token: token, Mode: mode, Profile: ctxName}, 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
|
|
}
|