2026-05-14 15:28:14 +00:00
|
|
|
// Package agentcmd holds the `weknora agent` command tree:
|
2026-06-26 12:40:59 +00:00
|
|
|
// list / view / create / update / delete / status / check. The directory is
|
2026-05-21 10:42:27 +00:00
|
|
|
// named `agent/` to match the cobra subcommand; the Go package is `agentcmd`
|
docs(cli): README / AGENTS.md / CHANGELOG + CI parity test
Wire-contract documentation and the CI check that keeps it honest.
* cli/README.md gains a verbatim --help block (top-level + subtrees),
an Exit codes table covering 0/1/2/3/4/5/6/7/10/124/130, a "Status
vs check" verb-pair subtable, and a "doc wait" paragraph spelling out
the four exit codes (0 / 1 / 124 / 130). The api passthrough note
trims storage provider out of the deep-config list now that
kb create --storage-provider is a polished flag.
* cli/AGENTS.md becomes the contributor guide: build/test, CRUD flag
conventions, the status/check verb pattern, long-poll wait commands,
the SetAgentHelp pattern, and a full Error code reference with 35
typed codes mapped to namespaces, exit codes, retryable / hint
guidance. Reference section is bracketed by HTML markers so a CI
parity test can keep it in sync with AllCodes().
* cli/internal/cmdutil/errors_doc_test.go enforces parity: every code
in AllCodes() must appear in AGENTS.md inside the markers, and
AGENTS.md must not reference codes that no longer exist. Fails CI
if a new typed code is added without documentation.
* CHANGELOG.md gets the v0.6 entry: BREAKING (--json / --no-stream /
WEKNORA_SDK_DEBUG / kb create --name), Added (--format / --jq /
doc wait / --log-level / kb-and-agent status & check / multi-id
delete / api --paginate / MCP schema extension / SetAgentHelp /
signal-aware ctx / kb create --storage-provider / new operation.*
namespace), Changed (multi-id partial-failure exit code, doc upload
FlagError, --log-level FlagError, multi-id stdout cleanup, README /
AGENTS.md changes), with a Migration from v0.5 section walking
every BREAKING through its v0.6 replacement.
2026-05-17 17:38:42 +00:00
|
|
|
// to avoid colliding with cobra's *cobra.Command identifier.
|
2026-05-14 15:28:14 +00:00
|
|
|
//
|
refactor(cli): drop aiclient package; align AGENTS.md with mainstream
Survey of 10 mainstream CLIs (gh, lark, stripe, vercel, supabase, aws,
azure, gcloud, openai/codex, github-copilot-cli) showed env-gated
per-command --help blurbs are a Stripe-only pattern; gh uses env detect
for telemetry only, and lark relies on installed agent Skills + MCP.
Our cmd/mcp/serve already covers the dominant 2025/26 path, so
internal/aiclient/ (136 LOC + 38 callsites) is net maintenance burden
without precedent.
- Drop internal/aiclient/ entirely (annotations + detect + tests)
- Remove 38 SetAgentHelp callsites + agentAwareHelpFunc / SetHelpFunc
wiring in cmd/root.go
- Migrate 4 command-level rules to standard Long help (visible to all,
not env-gated): doc upload mode mutex, kb edit at-least-one,
kb pin idempotent, search chunks channel mutex
- Rewrite AGENTS.md as a developer guide (gh-style 6 H2 / 167 lines):
audience preamble + Build / Architecture / Command Structure /
Testing / Code Style / Error Handling. Drops sections absent in
surveyed projects (Commit & PR Conventions, Who Uses This CLI)
- Clean 14 internal doc refs (ADR-N, spec §X, v0.X) in source comments
and docs that pointed at docs/superpowers/ — that directory is
local-only / uncommitted, so refs are dead for outside readers
- Drop forward-looking "once v0.2 ships" from README
2026-05-14 18:16:45 +00:00
|
|
|
// "agent" in this subtree refers to WeKnora's user-defined Custom
|
2026-05-21 10:42:27 +00:00
|
|
|
// Agents (server resource: GET/POST /agents/...) and handles CRUD
|
|
|
|
|
// operations only. Agent invocation has moved to `weknora session ask
|
|
|
|
|
// --agent <id>` (see cli/cmd/session/ask.go).
|
2026-05-14 15:28:14 +00:00
|
|
|
package agentcmd
|
|
|
|
|
|
|
|
|
|
import (
|
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
|
|
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
// NewCmd builds the `weknora agent` parent and registers leaves. Called
|
|
|
|
|
// from cli/cmd/root.go.
|
|
|
|
|
func NewCmd(f *cmdutil.Factory) *cobra.Command {
|
|
|
|
|
cmd := &cobra.Command{
|
|
|
|
|
Use: "agent",
|
2026-05-21 10:42:27 +00:00
|
|
|
Short: "Manage custom agents (CRUD + status/check)",
|
2026-05-14 15:28:14 +00:00
|
|
|
Long: `Custom Agents bundle a system prompt, model, tool allow-list, and KB
|
2026-06-26 12:40:59 +00:00
|
|
|
scope into an addressable resource. Create, update, list, view, check,
|
2026-05-21 10:42:27 +00:00
|
|
|
or delete agents. To invoke an agent, use: weknora session ask --agent <id>`,
|
2026-05-14 15:28:14 +00:00
|
|
|
}
|
|
|
|
|
cmd.AddCommand(NewCmdList(f))
|
|
|
|
|
cmd.AddCommand(NewCmdView(f))
|
2026-05-15 18:35:30 +00:00
|
|
|
cmd.AddCommand(NewCmdCreate(f))
|
|
|
|
|
cmd.AddCommand(NewCmdEdit(f))
|
|
|
|
|
cmd.AddCommand(NewCmdDelete(f))
|
2026-05-17 17:38:16 +00:00
|
|
|
cmd.AddCommand(NewCmdStatus(f))
|
|
|
|
|
cmd.AddCommand(NewCmdCheck(f))
|
2026-05-14 15:28:14 +00:00
|
|
|
return cmd
|
|
|
|
|
}
|