Files
Enterprise-Knowledge-Base/cli/cmd/skills/skills.go
T
nullkey d3c03b2f34 feat(cli)!: v0.10 reliability, agent-UX, and command-surface hardening
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.
2026-07-06 22:53:01 +08:00

215 lines
7.1 KiB
Go

// Package skillscmd holds the `weknora skills` command tree: list the bundled
// Agent Skills and install (write) them to an agent's skills directory. The
// skill markdown is embedded in the binary (see cli/skills), so install works
// without a source checkout — replacing the manual symlink-from-checkout MVP.
//
// Package name `skillscmd` avoids colliding with the embed package `skills`.
package skillscmd
import (
"fmt"
"os"
"path/filepath"
"strings"
"text/tabwriter"
"github.com/spf13/cobra"
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
"github.com/Tencent/WeKnora/cli/internal/iostreams"
"github.com/Tencent/WeKnora/cli/internal/output"
skillsfs "github.com/Tencent/WeKnora/cli/skills"
)
// NewCmd builds the `weknora skills` parent command.
func NewCmd(f *cmdutil.Factory) *cobra.Command {
cmd := &cobra.Command{
Use: "skills",
Short: "List and install the bundled Agent Skills",
}
cmd.AddCommand(newCmdList())
cmd.AddCommand(newCmdInstall())
return cmd
}
var skillsListFields = []string{"name", "description", "files"}
func newCmdList() *cobra.Command {
cmd := &cobra.Command{
Use: "list",
Short: "List the Agent Skills bundled in this binary",
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())
skills, err := skillsfs.List()
if err != nil {
return cmdutil.Wrapf(cmdutil.CodeInternalError, err, "read embedded skills")
}
if fopts.WantsJSON() {
return fopts.Emit(iostreams.IO.Out, skills, &output.Meta{Count: output.IntPtr(len(skills))})
}
tw := tabwriter.NewWriter(iostreams.IO.Out, 0, 0, 2, ' ', 0)
fmt.Fprintln(tw, "NAME\tFILES\tDESCRIPTION")
for _, s := range skills {
fmt.Fprintf(tw, "%s\t%d\t%s\n", s.Name, len(s.Files), s.Description)
}
return tw.Flush()
},
}
cmdutil.AddFormatFlag(cmd, skillsListFields...)
cmdutil.SetAgentHelp(cmd, cmdutil.AgentHelp{
UsedFor: "list the Agent Skills bundled in this CLI binary (name, description, file count) — discover what `weknora skills install` would write",
Examples: []string{"weknora skills list --format json"},
Output: "envelope.data is an array of {name, description, files[]}",
})
return cmd
}
type installResult struct {
Dir string `json:"dir"`
Installed []string `json:"installed"`
Skills []string `json:"skills"`
}
func newCmdInstall() *cobra.Command {
var dir string
var force bool
var dryRun bool
cmd := &cobra.Command{
Use: "install",
Short: "Write the bundled Agent Skills to an agent's skills directory",
Long: `Write the embedded Agent Skills to disk so an agent (e.g. Claude Code) can
load them. Defaults to ~/.claude/skills; override with --dir for other agents.
Existing files are left untouched unless --force is passed.`,
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())
target, err := resolveDir(dir)
if err != nil {
return err
}
skills, err := skillsfs.List()
if err != nil {
return cmdutil.Wrapf(cmdutil.CodeInternalError, err, "read embedded skills")
}
var planned []string
names := make([]string, 0, len(skills))
for _, s := range skills {
names = append(names, s.Name)
for _, rel := range s.Files {
planned = append(planned, filepath.Join(target, rel))
}
}
if handled, err := cmdutil.HandleDryRun(c, dryRun, cmdutil.DryRunPlan{
Action: "skills.install",
Args: map[string]any{
"dir": target,
"skills": names,
"files": planned,
},
}); handled {
return err
}
installed, err := writeSkills(skills, target, force)
if err != nil {
return err
}
res := installResult{Dir: target, Installed: installed, Skills: names}
if fopts.WantsJSON() {
return fopts.Emit(iostreams.IO.Out, res, nil)
}
fmt.Fprintf(iostreams.IO.Out, "✓ Installed %d skill(s) to %s\n", len(names), target)
for _, p := range installed {
fmt.Fprintf(iostreams.IO.Out, " %s\n", p)
}
return nil
},
}
cmd.Flags().StringVar(&dir, "dir", "", "Target skills directory (default: ~/.claude/skills)")
cmd.Flags().BoolVar(&force, "force", false, "Overwrite existing skill files")
cmdutil.AddFormatFlag(cmd, "dir", "installed", "skills")
cmdutil.AddDryRunFlag(cmd, &dryRun)
cmdutil.SetAgentHelp(cmd, cmdutil.AgentHelp{
UsedFor: "write the bundled Agent Skills to an agent's skills directory (default ~/.claude/skills) so the agent can load them; --dry-run previews the file list",
Examples: []string{"weknora skills install --dry-run --format json", "weknora skills install --dir ~/.claude/skills --force"},
Output: "envelope.data is {dir, installed:[paths], skills:[names]}",
})
return cmd
}
// resolveDir returns the explicit --dir or the default ~/.claude/skills. A
// leading ~ in --dir is expanded to the home directory — otherwise a quoted
// `--dir '~/foo'` (which the shell leaves literal) would create a bogus "~"
// directory tree.
func resolveDir(dir string) (string, error) {
if dir != "" {
return expandTilde(dir)
}
home, err := os.UserHomeDir()
if err != nil {
return "", cmdutil.NewError(cmdutil.CodeInputInvalidArgument,
"could not determine home directory; pass --dir explicitly")
}
return filepath.Join(home, ".claude", "skills"), nil
}
// expandTilde resolves a leading "~" or "~/" path segment to the user's home
// directory. Other forms (including "~user" and a ~ that isn't the first
// segment) are returned unchanged — matching the common shell behavior a CLI
// is expected to reproduce when it receives an unexpanded literal tilde.
func expandTilde(path string) (string, error) {
if path != "~" && !strings.HasPrefix(path, "~/") {
return path, nil
}
home, err := os.UserHomeDir()
if err != nil {
return "", cmdutil.NewError(cmdutil.CodeInputInvalidArgument,
"could not expand ~ (home directory unknown); pass an absolute --dir")
}
if path == "~" {
return home, nil
}
return filepath.Join(home, path[len("~/"):]), nil
}
// writeSkills writes every embedded skill file under target, creating parent
// dirs. Without --force, an existing file is skipped (not overwritten). Returns
// the paths actually written.
func writeSkills(skills []skillsfs.Skill, target string, force bool) ([]string, error) {
var written []string
for _, s := range skills {
for _, rel := range s.Files {
dst := filepath.Join(target, rel)
if !force {
if _, err := os.Stat(dst); err == nil {
continue // exists; leave it
}
}
if err := os.MkdirAll(filepath.Dir(dst), 0o755); err != nil {
return written, cmdutil.Wrapf(cmdutil.CodeLocalFileIO, err, "create dir for %s", dst)
}
b, err := skillsfs.ReadFile(rel)
if err != nil {
return written, cmdutil.Wrapf(cmdutil.CodeInternalError, err, "read embedded %s", rel)
}
if err := os.WriteFile(dst, b, 0o644); err != nil {
return written, cmdutil.Wrapf(cmdutil.CodeLocalFileIO, err, "write %s", dst)
}
written = append(written, dst)
}
}
return written, nil
}