refactor(cli): --limit/--all-pages, Go 1.26, internal/agent → aiclient
Cross-cutting cleanup that lands alongside the new feature surface: - `--limit / -L` and `--all-pages` on every list command. Default --limit 30 (gh-parity); --all-pages drains every server page client-side, capped by --limit. Closes the audit finding that the old "1000 max per call" implicit cap was undiscoverable. - `auth token` emits a TTY-only stderr advisory when stdout is a terminal (the credential just got displayed in scrollback) plus an api-key-mode rotation hint. - Comment + doc discipline pass: drop external project name references from in-code comments (we reference them in design notes, not inline). - Bump `go` directive to 1.26.0 and CI matrix to 1.26.x to align with the main module's go.mod. - Rename `cli/internal/agent` → `cli/internal/aiclient` to disambiguate from the new `cli/cmd/agent` resource subtree. The package handles AI coding-agent env detection + per-command --help annotations; the new name reflects that more precisely.
This commit is contained in:
@@ -1,4 +1,4 @@
|
||||
package agent
|
||||
package aiclient
|
||||
|
||||
import (
|
||||
"strings"
|
||||
@@ -7,7 +7,7 @@
|
||||
//
|
||||
// What remains here: a small env-detect for known coding agents, used purely
|
||||
// to render the AGENT-targeted help section (no behavior change).
|
||||
package agent
|
||||
package aiclient
|
||||
|
||||
import "os"
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
package agent
|
||||
package aiclient
|
||||
|
||||
import (
|
||||
"testing"
|
||||
@@ -26,12 +26,11 @@ func (o *JSONOptions) Enabled() bool { return o != nil }
|
||||
// after it). pflag's NoOptDefVal mechanism stores this sentinel into the
|
||||
// slice; CheckJSONFlags then maps it to "no field filter" (full envelope).
|
||||
//
|
||||
// This is a documented divergence from gh CLI, where bare `--json` errors
|
||||
// with a field-list discovery prompt. weknora's envelope is itself the
|
||||
// machine-readable contract (carries typed error.code / _meta / risk),
|
||||
// so `--json` bare always producing the full envelope keeps v0.3 caller
|
||||
// scripts and the typical agent pipe-to-jq pattern working. Field
|
||||
// discovery moves to per-command `--help` "JSON fields:" sections.
|
||||
// Rationale: WeKnora's envelope is itself the machine-readable contract
|
||||
// (carries typed error.code / _meta / risk), so a bare `--json` always
|
||||
// producing the full envelope keeps the standard `weknora kb list --json |
|
||||
// jq` pattern working. Field discovery moves to per-command `--help`
|
||||
// "JSON fields available" sections rendered by AddJSONFlags.
|
||||
const jsonNoOptSentinel = "\x00json-no-value"
|
||||
|
||||
// AddJSONFlags registers --json and --jq on cmd.
|
||||
@@ -74,10 +73,6 @@ func AddJSONFlags(cmd *cobra.Command, fields []string) {
|
||||
//
|
||||
// Bare `--json` yields Fields == nil (full envelope). Explicit field list
|
||||
// yields Fields == []string{"id", "name", ...} (filter applied).
|
||||
//
|
||||
// gh divergence: gh errors on bare --json with a discovery prompt. weknora
|
||||
// treats bare --json as "full envelope, no filter" because the envelope is
|
||||
// the contract.
|
||||
func CheckJSONFlags(cmd *cobra.Command) (*JSONOptions, error) {
|
||||
f := cmd.Flags()
|
||||
jsonFlag := f.Lookup("json")
|
||||
@@ -105,7 +100,8 @@ func CheckJSONFlags(cmd *cobra.Command) (*JSONOptions, error) {
|
||||
return opts, nil
|
||||
}
|
||||
if jqFlag != nil && jqFlag.Changed {
|
||||
// gh parity: plain error, exit 1 (not FlagError → exit 2).
|
||||
// Plain error, exit 1 (not FlagError → exit 2): the flag itself
|
||||
// parsed fine, the combination is what's wrong.
|
||||
return nil, errors.New("cannot use `--jq` without specifying `--json`")
|
||||
}
|
||||
return nil, nil
|
||||
|
||||
@@ -62,6 +62,11 @@ type Risk struct {
|
||||
}
|
||||
|
||||
// Meta carries non-payload context fields useful to agents and observability.
|
||||
//
|
||||
// Pagination metadata (Page / PageSize / Total) lives here rather than in
|
||||
// data.{...} so every list command's `data` field has the same shape —
|
||||
// always `{items: [...]}` — and agents can branch on the resource type
|
||||
// without per-list parser variants.
|
||||
type Meta struct {
|
||||
Context string `json:"context,omitempty"`
|
||||
TenantID uint64 `json:"tenant_id,omitempty"`
|
||||
@@ -69,6 +74,9 @@ type Meta struct {
|
||||
RequestID string `json:"request_id,omitempty"`
|
||||
NextCursor string `json:"next_cursor,omitempty"`
|
||||
HasMore bool `json:"has_more,omitempty"`
|
||||
Page int `json:"page,omitempty"`
|
||||
PageSize int `json:"page_size,omitempty"`
|
||||
Total int64 `json:"total,omitempty"`
|
||||
Warnings []string `json:"warnings,omitempty"`
|
||||
AppliedFilters []string `json:"applied_filters,omitempty"`
|
||||
}
|
||||
|
||||
@@ -60,8 +60,9 @@ func marshalEnvelope(env Envelope) ([]byte, error) {
|
||||
// defensive): filter each [*].
|
||||
// - data is nil / scalar: unchanged.
|
||||
//
|
||||
// Unknown field names are silently ignored (consistent with gh — users may
|
||||
// pass an aspirational field set across heterogenous list outputs).
|
||||
// Unknown field names are silently ignored so a user may pass an
|
||||
// aspirational field set across heterogenous list outputs without per-
|
||||
// command tailoring.
|
||||
func applyFieldFilter(envelopeJSON []byte, fields []string) ([]byte, error) {
|
||||
var raw map[string]json.RawMessage
|
||||
if err := json.Unmarshal(envelopeJSON, &raw); err != nil {
|
||||
@@ -160,9 +161,10 @@ func filterObjectKeys(objRaw json.RawMessage, fields []string) (json.RawMessage,
|
||||
return json.Marshal(dst)
|
||||
}
|
||||
|
||||
// writeJQ evaluates expr against envelopeJSON and writes each result line by
|
||||
// line to w. Mirrors gh's pkg/export/filter.go semantics: results that are
|
||||
// strings render without quotes; everything else uses encoding/json.
|
||||
// writeJQ evaluates expr against envelopeJSON and writes each result line
|
||||
// by line to w. String results render without quotes (so `--jq '.x.name'`
|
||||
// yields shell-friendly bare strings); non-string results use
|
||||
// encoding/json.
|
||||
//
|
||||
// Returns input.invalid_argument-shaped errors via plain errors.New + fmt;
|
||||
// the caller is responsible for wrapping with cmdutil.NewError if it wants
|
||||
|
||||
@@ -9,9 +9,8 @@
|
||||
// don't belong on an agent-callable surface).
|
||||
// - Long-running tools (chat / agent_invoke) accumulate the LLM SSE
|
||||
// stream server-side and return a single CallToolResult — MCP spec
|
||||
// 2025-06-18 does not define streamed tool-result content, so this is
|
||||
// the canonical pattern (see Anthropic reference `everything` server
|
||||
// and Stripe @stripe/mcp).
|
||||
// 2025-06-18 does not define streamed tool-result content, so the
|
||||
// accumulate-and-return pattern is the canonical path.
|
||||
// - Handlers receive ctx for cancellation; mid-LLM-stream cancellation
|
||||
// propagates to the SDK via context, which closes the SSE connection.
|
||||
package mcp
|
||||
|
||||
@@ -19,8 +19,15 @@ import (
|
||||
// Zero value is ready to use. Not safe for concurrent Append calls — the SDK
|
||||
// invokes its callback sequentially on a single goroutine, so this matches
|
||||
// the only contract that exists today.
|
||||
//
|
||||
// Demuxes by ResponseType so the answer string is not polluted by thinking
|
||||
// or reflection fragments — the model layer (internal/models/chat/
|
||||
// remote_api.go) emits ResponseTypeThinking events whenever the upstream
|
||||
// LLM produces reasoning_content (GPT-5 / Claude extended thinking), and
|
||||
// without demux those would be silently concatenated into Result().
|
||||
type Accumulator struct {
|
||||
builder strings.Builder
|
||||
answer strings.Builder
|
||||
thinking strings.Builder
|
||||
References []*sdk.SearchResult
|
||||
SessionID string
|
||||
AssistantMessageID string
|
||||
@@ -33,8 +40,23 @@ func (a *Accumulator) Append(r *sdk.StreamResponse) {
|
||||
if r == nil || a.finished {
|
||||
return
|
||||
}
|
||||
if r.Content != "" {
|
||||
a.builder.WriteString(r.Content)
|
||||
switch r.ResponseType {
|
||||
case sdk.ResponseTypeAnswer:
|
||||
if r.Content != "" {
|
||||
a.answer.WriteString(r.Content)
|
||||
}
|
||||
case sdk.ResponseTypeThinking, sdk.ResponseTypeReflection:
|
||||
if r.Content != "" {
|
||||
a.thinking.WriteString(r.Content)
|
||||
}
|
||||
default:
|
||||
// Frames without a typed ResponseType (legacy / metadata-only
|
||||
// payloads) that still carry an answer fragment fall through here.
|
||||
// Preserve the legacy contract by treating untyped Content as
|
||||
// answer text.
|
||||
if r.ResponseType == "" && r.Content != "" {
|
||||
a.answer.WriteString(r.Content)
|
||||
}
|
||||
}
|
||||
if r.SessionID != "" && a.SessionID == "" {
|
||||
a.SessionID = r.SessionID
|
||||
@@ -61,5 +83,10 @@ func (a *Accumulator) Append(r *sdk.StreamResponse) {
|
||||
// Done reports whether a terminal event was observed.
|
||||
func (a *Accumulator) Done() bool { return a.finished }
|
||||
|
||||
// Result returns the concatenated content string.
|
||||
func (a *Accumulator) Result() string { return a.builder.String() }
|
||||
// Result returns the accumulated answer-event content.
|
||||
func (a *Accumulator) Result() string { return a.answer.String() }
|
||||
|
||||
// Thinking returns the accumulated reasoning / reflection content surfaced
|
||||
// by the upstream LLM (only populated when the active model produces
|
||||
// reasoning_content). Empty for non-reasoning models.
|
||||
func (a *Accumulator) Thinking() string { return a.thinking.String() }
|
||||
|
||||
@@ -6,8 +6,7 @@ import (
|
||||
"time"
|
||||
)
|
||||
|
||||
// FuzzyAgo formats t relative to now in the gh house style.
|
||||
// Mirrors github.com/cli/cli/internal/text/datetime.go FuzzyAgo.
|
||||
// FuzzyAgo formats t relative to now as a short relative-time string.
|
||||
//
|
||||
// Examples:
|
||||
//
|
||||
|
||||
Reference in New Issue
Block a user