2ce348d020
D1 — --format default flipped to json regardless of TTY: - v0.6: smart default (text on TTY, json on pipe). - v0.7: always json; TTY only affects indent (compact in pipe). Enum values unchanged (text | json | ndjson). - Typed FormatMode enum replaces untyped string consts. - --format / --jq promoted to persistent root flags so unknown- subcommand paths still reach the typed-envelope guard (per-command registration in v0.6 would have rejected --format on unknown commands as cobra-prose exit 2). - WEKNORA_FORMAT env var added; precedence --format > env > default. Invalid env values silently ignored. D2 — chat / session ask default to NDJSON event-stream: - New cli/internal/output/ndjson_stream.go: InitEvent struct + EmitInit / EmitSDKEvent / WriteNDJSONLine helpers. EmitInit doc encodes the must-be-first-line invariant agents key on. - chat / session ask: --format json AND --format ndjson both emit one JSON event per line (no envelope wrapping). CLI injects exactly one `init` event at stream head carrying session_id + optional kb_id / agent_id / profile. Subsequent events pass through verbatim from the SDK (passthrough discipline per spec §5.1). - --format text keeps the SSE-style live renderer. context → profile full cascade: - Command group: cli/cmd/context/ → cli/cmd/profile/ (git mv; package contextcmd → profilecmd). - Global flag --context → --profile. Factory.ContextOverride → ProfileOverride. WEKNORA_PROFILE env var honored (--profile flag > env > config.CurrentContext). When --profile or WEKNORA_PROFILE references a missing profile, the error is input.invalid_argument with hint "weknora profile list" — not the destructive local.config_corrupt path (which would have told users to delete their config file). - Binding file .weknora/project.yaml field context: → profile: (no backwards-compat alias; re-run weknora link). - profile use JSON fields current_context / previous_context → current_profile / previous_profile. - weknora link JSON field context → profile. - CodeLocalContextNotFound → CodeLocalProfileNotFound (typed code rename). - Envelope top-level profile field populated via globalProfile (set by root PersistentPreRunE from Factory.ActiveProfile). chat / session ask NDJSON init event carries the same profile. - Rationale: "context" collided with LLM context window / RAG context / Go context.Context; mainstream multi-credential CLIs (AWS / Stripe / OpenAI / Anthropic / lark) all use "profile". H2/C1' help calibration: - AgentHelp gains Warnings []string; single SetAgentHelp helper routes on WEKNORA_AGENT_HELP=1 (emits JSON blob including warnings) vs human help (appends "AI agents:" block from same source). Warnings surface as both a structured JSON field and visible help-text addendum without drift. - 9 destructive commands carry warnings: kb / doc / agent / session / chunk delete; profile remove; kb / agent edit; auth logout. - weknora doc wait dedups ids at entry; SIGINT mid-wait returns silently (root signal handler maps to exit 130) instead of being miscategorised as operation.timeout / operation.failed. A4 — docs: - cli/AGENTS.md gains four agent-facing sections: Wire contract for AI agents (stdout / stderr / NDJSON / _notice evolution / SDK contract boundary); Deliberate deviations + mainstream alignments; Pre-1.0 breaking policy; Exit-10 anti-patterns. ERROR_REFERENCE table extended. - cli/README.md adds Agent quick start under Wire contract. - cli/CHANGELOG.md v0.7 section: BREAKING entries with migration notes, Added (WEKNORA_FORMAT / WEKNORA_PROFILE / retry_command / retry_after_seconds / risk / _notice reserved infra / meta.count / meta.has_more / doc fetch / doc create / session ask / doc delete --all / NDJSON init), Changed (docs additions), Deprecated (none — pre-release one-shot breaking). Spec: docs/superpowers/specs/2026-05-20-weknora-cli-v0.7-design.md §3 / §4 / §5 / §6 / §11
149 lines
5.0 KiB
Go
149 lines
5.0 KiB
Go
package profilecmd
|
|
|
|
import (
|
|
"fmt"
|
|
"strings"
|
|
|
|
"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
|
|
}
|
|
|
|
// 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 with `weknora auth login --name <n>`,
|
|
// separating "where" the CLI talks to (the host) and "how" it authenticates
|
|
// (the credential). If you want one command for both, run
|
|
// `weknora auth login --name <n> --host <h>` instead.
|
|
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. Use ` + "`weknora auth login --name <n>`" + ` to
|
|
attach credentials in a single step instead, or run ` + "`weknora auth login --name <n>`" + ` after
|
|
` + "`weknora profile add`" + ` to fill them in.
|
|
|
|
The first profile added is auto-selected as the current profile. Subsequent
|
|
adds leave the current profile untouched.`,
|
|
Example: ` weknora profile add staging --host https://staging.example.com
|
|
weknora profile add prod --host https://prod.example.com --user alice@example.com`,
|
|
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())
|
|
return runAdd(opts, fopts, args[0])
|
|
},
|
|
}
|
|
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)")
|
|
cmdutil.AddFormatFlag(cmd, profileAddFields...)
|
|
_ = cmd.MarkFlagRequired("host")
|
|
return cmd
|
|
}
|
|
|
|
func runAdd(opts *AddOptions, fopts *cmdutil.FormatOptions, name string) error {
|
|
if err := validateName(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.Contexts[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 cfg.Contexts == nil {
|
|
cfg.Contexts = map[string]config.Context{}
|
|
}
|
|
cfg.Contexts[name] = config.Context{Host: host, User: opts.User}
|
|
wasFirst := cfg.CurrentContext == ""
|
|
if wasFirst {
|
|
cfg.CurrentContext = 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: wasFirst}, nil)
|
|
}
|
|
if wasFirst {
|
|
fmt.Fprintf(iostreams.IO.Out, "✓ Added profile %s (now current). Run `weknora auth login --name %s` to attach credentials.\n", name, name)
|
|
} else {
|
|
fmt.Fprintf(iostreams.IO.Out, "✓ Added profile %s. Run `weknora auth login --name %s` to attach credentials.\n", name, name)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// validateName enforces the allowlist advertised in the --help hint: letters,
|
|
// digits, dash, underscore, dot. The `.` exception lets emails / DNS-like
|
|
// names through; the path-traversal `..` is structurally rejected by a
|
|
// separate guard because it would let a hand-edited config.yaml claim a
|
|
// profile whose name walks out of the keyring namespace.
|
|
func validateName(name string) error {
|
|
if name == "" {
|
|
return &cmdutil.Error{
|
|
Code: cmdutil.CodeInputInvalidArgument,
|
|
Message: "profile name must not be empty",
|
|
}
|
|
}
|
|
if name == "." || name == ".." || strings.Contains(name, "/") || strings.Contains(name, "\\") {
|
|
return &cmdutil.Error{
|
|
Code: cmdutil.CodeInputInvalidArgument,
|
|
Message: fmt.Sprintf("profile name %q is reserved or path-like", name),
|
|
Hint: "use letters, digits, dashes, underscores, or dots",
|
|
}
|
|
}
|
|
for _, r := range name {
|
|
switch {
|
|
case r >= 'a' && r <= 'z',
|
|
r >= 'A' && r <= 'Z',
|
|
r >= '0' && r <= '9',
|
|
r == '-' || r == '_' || r == '.':
|
|
continue
|
|
default:
|
|
return &cmdutil.Error{
|
|
Code: cmdutil.CodeInputInvalidArgument,
|
|
Message: fmt.Sprintf("profile name %q contains invalid character %q", name, r),
|
|
Hint: "use letters, digits, dashes, underscores, or dots",
|
|
}
|
|
}
|
|
}
|
|
return nil
|
|
}
|