feat(cli): --json field-select, --jq, auth token, doc --from-url

Output ergonomics:
- `--json` accepts a comma-separated field list (gh-parity); selects
  named keys from the per-command payload. Bare `--json` keeps the
  full shape.
- `--jq <expr>` evaluates a gojq expression over the JSON; pairs with
  `--json field-list` so projection runs before jq.
- `--version` is a global cobra flag in addition to the `version`
  subcommand; both render the same line.
- Per-command `--help` now renders the available JSON field list under
  "JSON fields available via `--json id,name,...`" (field-discovery
  parity with gh / kubectl `-o jsonpath`).

New commands:
- `auth token` — print the active context's credential to stdout for
  shell command substitution (`WEKNORA_TOKEN=$(weknora auth token)`).
  Default: raw secret, no trailing newline. `--json` emits
  `{token, mode, context}`.
- `doc upload --from-url <URL>` — ingest a remote URL via the SDK
  `CreateKnowledgeFromURL`. `--name` forwarded as `FileName` so the
  server's known-extension heuristic upgrades crawl-mode to
  file-download-mode where appropriate.

Includes the simplify post-review polish pass (field-filter unit
tests, --json/--jq compose check, agent_help copy fixes).
This commit is contained in:
nullkey
2026-05-14 23:28:14 +08:00
committed by lyingbug
parent 4fb089d4d7
commit 1b20b06f5e
81 changed files with 2351 additions and 642 deletions
+18 -10
View File
@@ -21,9 +21,12 @@ import (
"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
JSONOut bool // --json
KB string // --kb: KB UUID or name; empty triggers interactive prompt on TTY
}
// linkResult is the typed payload emitted under data.
@@ -56,16 +59,20 @@ user explicitly asked to bind this directory; don't run it as a side effect.`,
weknora link # interactive (TTY)`,
Args: cobra.NoArgs,
RunE: func(c *cobra.Command, _ []string) error {
return runLink(c.Context(), opts, f)
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")
cmd.Flags().BoolVar(&opts.JSONOut, "json", false, "Output JSON envelope")
cmdutil.AddJSONFlags(cmd, linkFields)
agent.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, f *cmdutil.Factory) error {
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")
@@ -97,11 +104,12 @@ func runLink(ctx context.Context, opts *Options, f *cmdutil.Factory) error {
KBName: kbName,
ProjectLinkPath: linkPath,
}
if opts.JSONOut {
return format.WriteEnvelope(iostreams.IO.Out, format.Success(r, &format.Meta{
Context: ctxName,
KBID: kbID,
}))
if jopts.Enabled() {
return format.WriteEnvelopeFiltered(
iostreams.IO.Out,
format.Success(r, &format.Meta{Context: ctxName, KBID: kbID}),
jopts.Fields, jopts.JQ,
)
}
if kbName != "" {
fmt.Fprintf(iostreams.IO.Out, "✓ Linked %s to %s (kb=%s, id=%s)\n", linkPath, ctxName, kbName, kbID)
+5 -5
View File
@@ -65,7 +65,7 @@ func TestLink_ByID(t *testing.T) {
f := newFactory("default", nil)
opts := &Options{KB: "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa"}
require.NoError(t, runLink(context.Background(), opts, f))
require.NoError(t, runLink(context.Background(), opts, nil, f))
linkPath := filepath.Join(dir, ".weknora", "project.yaml")
p, err := projectlink.Load(linkPath)
@@ -87,7 +87,7 @@ func TestLink_ByName(t *testing.T) {
cli := sdk.NewClient(srv.URL)
f := newFactory("default", cli)
opts := &Options{KB: "foo"}
require.NoError(t, runLink(context.Background(), opts, f))
require.NoError(t, runLink(context.Background(), opts, nil, f))
p, err := projectlink.Load(filepath.Join(dir, ".weknora", "project.yaml"))
require.NoError(t, err)
@@ -103,7 +103,7 @@ func TestLink_KBNotFound(t *testing.T) {
cli := sdk.NewClient(srv.URL)
f := newFactory("default", cli)
opts := &Options{KB: "missing"}
err := runLink(context.Background(), opts, f)
err := runLink(context.Background(), opts, nil, f)
require.Error(t, err)
var typed *cmdutil.Error
require.ErrorAs(t, err, &typed)
@@ -123,7 +123,7 @@ func TestLink_OverwritesExisting(t *testing.T) {
f := newFactory("default", nil)
opts := &Options{KB: "22222222-2222-4222-8222-222222222222"}
require.NoError(t, runLink(context.Background(), opts, f))
require.NoError(t, runLink(context.Background(), opts, nil, f))
p, err := projectlink.Load(linkPath)
require.NoError(t, err)
@@ -140,7 +140,7 @@ func TestLink_NonInteractive_NoKB(t *testing.T) {
f := newFactory("default", nil)
opts := &Options{} // no KB
err := runLink(context.Background(), opts, f)
err := runLink(context.Background(), opts, nil, f)
require.Error(t, err)
var typed *cmdutil.Error
require.ErrorAs(t, err, &typed)
+18 -9
View File
@@ -13,9 +13,11 @@ import (
"github.com/Tencent/WeKnora/cli/internal/projectlink"
)
type UnlinkOptions struct {
JSONOut bool
}
// unlinkFields enumerates the fields surfaced for `--json` discovery on
// `unlink`. Tracks the small unlinkResult struct.
var unlinkFields = []string{"project_link_path"}
type UnlinkOptions struct{}
// unlinkResult is the typed payload emitted under data.
type unlinkResult struct {
@@ -40,15 +42,19 @@ is present anywhere in the parent chain.`,
weknora unlink --json # envelope output (CI / agents)`,
Args: cobra.NoArgs,
RunE: func(c *cobra.Command, _ []string) error {
return runUnlink(opts)
jopts, err := cmdutil.CheckJSONFlags(c)
if err != nil {
return err
}
return runUnlink(opts, jopts)
},
}
cmd.Flags().BoolVar(&opts.JSONOut, "json", false, "Output JSON envelope")
cmdutil.AddJSONFlags(cmd, unlinkFields)
agent.SetAgentHelp(cmd, "Removes .weknora/project.yaml (the cwd → KB binding). Walks up from cwd. Errors with input.invalid_argument when no link is present in the parent chain.")
return cmd
}
func runUnlink(opts *UnlinkOptions) error {
func runUnlink(opts *UnlinkOptions, jopts *cmdutil.JSONOptions) error {
cwd, err := os.Getwd()
if err != nil {
return cmdutil.Wrapf(cmdutil.CodeLocalFileIO, err, "get cwd")
@@ -67,9 +73,12 @@ func runUnlink(opts *UnlinkOptions) error {
if err := projectlink.Remove(linkPath); err != nil {
return cmdutil.Wrapf(cmdutil.CodeLocalFileIO, err, "remove %s", linkPath)
}
if opts.JSONOut {
return format.WriteEnvelope(iostreams.IO.Out, format.Success(
unlinkResult{ProjectLinkPath: linkPath}, nil))
if jopts.Enabled() {
return format.WriteEnvelopeFiltered(
iostreams.IO.Out,
format.Success(unlinkResult{ProjectLinkPath: linkPath}, nil),
jopts.Fields, jopts.JQ,
)
}
fmt.Fprintf(iostreams.IO.Out, "✓ Unlinked %s\n", linkPath)
return nil
+4 -4
View File
@@ -32,7 +32,7 @@ func TestUnlink_RemovesLinkInCwd(t *testing.T) {
linkPath := mkLinkFile(t, tmp)
t.Chdir(tmp)
if err := runUnlink(&UnlinkOptions{}); err != nil {
if err := runUnlink(&UnlinkOptions{}, nil); err != nil {
t.Fatalf("runUnlink: %v", err)
}
if _, err := os.Stat(linkPath); !os.IsNotExist(err) {
@@ -50,7 +50,7 @@ func TestUnlink_WalksUpFromSubdir(t *testing.T) {
}
t.Chdir(sub)
if err := runUnlink(&UnlinkOptions{}); err != nil {
if err := runUnlink(&UnlinkOptions{}, nil); err != nil {
t.Fatalf("runUnlink: %v", err)
}
if _, err := os.Stat(linkPath); !os.IsNotExist(err) {
@@ -63,7 +63,7 @@ func TestUnlink_NoLink_Errors(t *testing.T) {
tmp := t.TempDir()
t.Chdir(tmp)
err := runUnlink(&UnlinkOptions{})
err := runUnlink(&UnlinkOptions{}, nil)
if err == nil {
t.Fatal("expected error when no link present")
}
@@ -85,7 +85,7 @@ func TestUnlink_JSON_Envelope(t *testing.T) {
mkLinkFile(t, tmp)
t.Chdir(tmp)
if err := runUnlink(&UnlinkOptions{JSONOut: true}); err != nil {
if err := runUnlink(&UnlinkOptions{}, &cmdutil.JSONOptions{}); err != nil {
t.Fatalf("runUnlink: %v", err)
}
got := out.String()