e623e8208f
Removes the entire envelope machinery now that every success path
emits bare JSON:
- cli/internal/format/envelope.go (Envelope, Success, Failure,
SuccessWithRisk, WriteEnvelope, Meta, Notice, UpdateNotice,
VersionSkewNotice, Risk, RiskLevel, ErrorBody) + tests.
- cli/internal/format/filter.go envelope-specific helpers
(WriteEnvelopeFiltered, marshalEnvelope, applyFieldFilter,
filterDataPayload, filterObjectData); the reusable
filterArrayItems / filterObjectKeys / writeJQ stay for bare.go.
- cli/internal/cmdutil/exporter.go + tests (envelope-only).
- cli/internal/cmdutil/PrintErrorEnvelope + ToErrorBody +
operationRiskOf + Error.OperationRisk field + OperationRisk struct.
Error path: all errors now go to stderr via cmdutil.PrintError in
`code: message\nhint: ...` form, regardless of --json. Stdout stays
empty (or holds the partial-success the command already wrote) so
downstream `--json | jq` pipelines never have to filter error shapes
out of the success stream. Typed exit codes (3 auth.* / 4
resource.not_found / 5 input.* / 6 server.rate_limited / 7 server.*
+ network.* / 10 input.confirmation_required) carry the failure
class for agents that branch on it.
Acceptance contract:
- envelope_test.go → wire_test.go (TestEnvelopeGolden → TestWireGolden).
- testdata/envelopes/ → testdata/wire/.
- Error-path cases assert the typed code substring on stderr.
- Orphan whoami.*.json goldens deleted.
AGENTS.md + README.md rewritten for the bare-data contract:
- Drop envelope schema section + dry-run rule.
- Document bare JSON on stdout + `code: msg\nhint: …` on stderr.
- ADR-3 reframed around bare data and why error separation matters
for `--json | jq` pipelines.
WriteJSONFiltered short-circuits to WriteJSON when both filters are
empty (skip the marshal-buffer round-trip for the common case).
Final review pass:
- Fix wire-contract bug: `--json id,name` (space form) is broken by
pflag's NoOptDefVal; AGENTS.md / README.md / SetAgentHelp + the
field-discovery help text all switched to `--json=id,name`.
- Fix `weknora api --jq` silently ignored: api.go now routes through
WriteJSONFiltered with jopts.JQ.
- AGENTS.md: drop the false claim that `auth logout` honors `-y`
(logout is local-only with no ConfirmDestructive guard); list the
actual destructive commands instead.
- Rewrite cli/acceptance/e2e/e2e_test.go for the bare-data wire shape
(was still parsing `out["data"]` / `env["ok"]`).
- Add `JSONOptions.Emit(w, v)` helper; collapse ~33 repeated
`format.WriteJSONFiltered(iostreams.IO.Out, X, jopts.Fields,
jopts.JQ)` sites to `jopts.Emit(iostreams.IO.Out, X)` — drops the
format import from 22 cmd/* files.
- Delete single-caller `cmdutil.MustRequireFlag`; inline as
`_ = cmd.MarkFlagRequired(...)` everywhere.
- Add `_ = cmd.MarkFlagRequired("name")` to `kb create`; it was the
only write command relying on runtime --name validation while
`context add` already used the cobra-level mark.
- `context use`: register `--json` / `--jq` (was always emitting JSON
unconditionally with no human path and no flag — diverged from
every other write command); human mode now prints
`✓ Switched context to X (was Y)`.
- Replace per-package `confirmPrompter` / `scriptedConfirm` /
`errPrompter` test doubles with `testutil.ConfirmPrompter`.
- Rename `chatService` → `ChatService` (export to match siblings
`ListService` / `ViewService`); rename `printUploadSuccess` →
`renderUploadSuccess` (siblings use `render*`).
- `defaultHint(CodeResourceNotFound)`: drop the hardcoded
"list available with `weknora kb list`" — misleading on agent /
doc / session 404. Replaced with "verify the resource ID and try
again".
- Strip stale `v0.2/v0.3` / "envelope" / "v0.0/v0.1 supports only"
historical tags from production comments and a few test
descriptions.
188 lines
6.3 KiB
Go
188 lines
6.3 KiB
Go
// Package linkcmd implements `weknora link` — binds the current working
|
|
// directory to a knowledge base by writing .weknora/project.yaml. Always
|
|
// overwrites an existing link silently rather than refusing when one is
|
|
// already present. The cobra Long: text covers the user-facing modes
|
|
// (--kb / TTY / non-TTY).
|
|
package linkcmd
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"os"
|
|
"path/filepath"
|
|
"time"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/aiclient"
|
|
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
|
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
|
"github.com/Tencent/WeKnora/cli/internal/projectlink"
|
|
)
|
|
|
|
// linkFields enumerates the fields surfaced for `--json` discovery on
|
|
// `link`. Tracks the small linkResult struct.
|
|
var linkFields = []string{"context", "kb_id", "kb_name", "project_link_path"}
|
|
|
|
type Options struct {
|
|
KB string // --kb: KB UUID or name; empty triggers interactive prompt on TTY
|
|
}
|
|
|
|
// linkResult is the typed payload emitted under data.
|
|
type linkResult struct {
|
|
Context string `json:"context"`
|
|
KBID string `json:"kb_id"`
|
|
KBName string `json:"kb_name,omitempty"`
|
|
ProjectLinkPath string `json:"project_link_path"`
|
|
}
|
|
|
|
// NewCmd builds the `weknora link` command.
|
|
func NewCmd(f *cmdutil.Factory) *cobra.Command {
|
|
opts := &Options{}
|
|
cmd := &cobra.Command{
|
|
Use: "link",
|
|
Short: "Bind the current directory to a knowledge base",
|
|
Long: `Writes .weknora/project.yaml in the current working directory pointing
|
|
at the supplied knowledge base. Subsequent commands run from this directory
|
|
(or any subdirectory) automatically resolve --kb from the link unless
|
|
overridden by the --kb flag or WEKNORA_KB_ID env var.
|
|
|
|
Pass --kb <id-or-name> for non-interactive use (scripts, CI). Run on a TTY
|
|
without --kb to be prompted from the list of available KBs. Always overwrites
|
|
any existing link — re-run to switch.
|
|
|
|
AI agents: link writes to the user's working directory. Only run it when the
|
|
user explicitly asked to bind this directory; don't run it as a side effect.`,
|
|
Example: ` weknora link --kb a32a63ff-fb36-4874-bcaa-30f48570a694 # explicit UUID
|
|
weknora link --kb engineering # name → id
|
|
weknora link # interactive (TTY)`,
|
|
Args: cobra.NoArgs,
|
|
RunE: func(c *cobra.Command, _ []string) error {
|
|
jopts, err := cmdutil.CheckJSONFlags(c)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return runLink(c.Context(), opts, jopts, f)
|
|
},
|
|
}
|
|
cmd.Flags().StringVar(&opts.KB, "kb", "", "Knowledge base UUID or name; omit on a TTY for interactive prompt")
|
|
cmdutil.AddJSONFlags(cmd, linkFields)
|
|
aiclient.SetAgentHelp(cmd, "Writes .weknora/project.yaml binding cwd to a KB. Pass --kb (id or name) for non-interactive use. Always overwrites.")
|
|
return cmd
|
|
}
|
|
|
|
func runLink(ctx context.Context, opts *Options, jopts *cmdutil.JSONOptions, f *cmdutil.Factory) error {
|
|
cwd, err := os.Getwd()
|
|
if err != nil {
|
|
return cmdutil.Wrapf(cmdutil.CodeLocalFileIO, err, "get cwd")
|
|
}
|
|
linkPath := filepath.Join(cwd, projectlink.DirName, projectlink.FileName)
|
|
|
|
ctxName, err := resolveContext(f)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
kbID, kbName, err := resolveKB(ctx, opts, f)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
link := &projectlink.Project{
|
|
Context: ctxName,
|
|
KBID: kbID,
|
|
CreatedAt: time.Now().UTC(),
|
|
}
|
|
if err := projectlink.Save(linkPath, link); err != nil {
|
|
return cmdutil.Wrapf(cmdutil.CodeLocalFileIO, err, "write project link")
|
|
}
|
|
|
|
r := linkResult{
|
|
Context: ctxName,
|
|
KBID: kbID,
|
|
KBName: kbName,
|
|
ProjectLinkPath: linkPath,
|
|
}
|
|
if jopts.Enabled() {
|
|
return jopts.Emit(iostreams.IO.Out, r)
|
|
}
|
|
if kbName != "" {
|
|
fmt.Fprintf(iostreams.IO.Out, "✓ Linked %s to %s (kb=%s, id=%s)\n", linkPath, ctxName, kbName, kbID)
|
|
} else {
|
|
fmt.Fprintf(iostreams.IO.Out, "✓ Linked %s to %s (kb_id=%s)\n", linkPath, ctxName, kbID)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// resolveContext picks the auth context to record in the link. There is no
|
|
// per-invocation override flag on `weknora link` itself — to record under a
|
|
// different context, use the global persistent flag (`weknora --context
|
|
// staging link --kb my-kb`); the active context at link time is what gets
|
|
// written.
|
|
func resolveContext(f *cmdutil.Factory) (string, error) {
|
|
cfg, err := f.Config()
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
if cfg.CurrentContext == "" {
|
|
return "", cmdutil.NewError(cmdutil.CodeAuthUnauthenticated, "no active context; run `weknora auth login` first")
|
|
}
|
|
return cfg.CurrentContext, nil
|
|
}
|
|
|
|
// resolveKB resolves --kb to (kbID, kbName). Name is empty when the user
|
|
// passed an id directly. Falls through to an interactive prompt on a TTY
|
|
// when --kb is empty; errors on non-TTY.
|
|
func resolveKB(ctx context.Context, opts *Options, f *cmdutil.Factory) (string, string, error) {
|
|
if opts.KB != "" {
|
|
if cmdutil.IsKBID(opts.KB) {
|
|
return opts.KB, "", nil
|
|
}
|
|
cli, err := f.Client()
|
|
if err != nil {
|
|
return "", "", err
|
|
}
|
|
id, err := cmdutil.ResolveKBNameToID(ctx, cli, opts.KB)
|
|
if err != nil {
|
|
return "", "", err
|
|
}
|
|
return id, opts.KB, nil
|
|
}
|
|
if !iostreams.IO.IsStdoutTTY() {
|
|
return "", "", cmdutil.NewError(cmdutil.CodeKBIDRequired, "--kb is required (no TTY for interactive prompt)")
|
|
}
|
|
cli, err := f.Client()
|
|
if err != nil {
|
|
return "", "", err
|
|
}
|
|
return promptForKB(ctx, cli, f)
|
|
}
|
|
|
|
// promptForKB lists available knowledge bases on stderr, then asks the user
|
|
// for an id or name. Resolved against the listed set so a typed name is
|
|
// converted to the canonical id.
|
|
func promptForKB(ctx context.Context, svc cmdutil.KBLister, f *cmdutil.Factory) (string, string, error) {
|
|
kbs, err := svc.ListKnowledgeBases(ctx)
|
|
if err != nil {
|
|
return "", "", cmdutil.WrapHTTP(err, "list knowledge bases")
|
|
}
|
|
if len(kbs) == 0 {
|
|
return "", "", cmdutil.NewError(cmdutil.CodeKBNotFound, "no knowledge bases visible to active context; create one first")
|
|
}
|
|
fmt.Fprintln(iostreams.IO.Err, "Available knowledge bases:")
|
|
for _, kb := range kbs {
|
|
fmt.Fprintf(iostreams.IO.Err, " %s %s\n", kb.ID, kb.Name)
|
|
}
|
|
p := f.Prompter()
|
|
answer, err := p.Input("Knowledge base id or name", "")
|
|
if err != nil {
|
|
return "", "", cmdutil.Wrapf(cmdutil.CodeInputMissingFlag, err, "kb prompt")
|
|
}
|
|
for _, kb := range kbs {
|
|
if kb.ID == answer || kb.Name == answer {
|
|
return kb.ID, kb.Name, nil
|
|
}
|
|
}
|
|
return "", "", cmdutil.NewError(cmdutil.CodeKBNotFound, fmt.Sprintf("knowledge base not found: %s", answer))
|
|
}
|