Add cross-system read-only search
One query now finds anything in the system over the wire and from the CLI. - protocol: add Search/SearchResults message types and a SearchRequest (query, optional kind filter, optional limit) / SearchResponse (typed, ranked matches plus truncation and scan-bound counters) pair, with typed payloads for pipeline, version, run, step/visit, field text and artifact. - store: add Store.Search, a read-only query over pipelines, pipeline_versions, pipeline_runs, run_steps (+step_control) and step_artifacts. Ranks exact name (3) > name substring (2) > body text (1), breaks ties by recency then a stable kind/target order, and reports the matched field. Bounds work with a 50-default/200-max result cap, a 2000-row per-kind scan limit and a 2000-step / 1 MiB field-text scan budget. - terms: a bare status word or lone date expression (today, yesterday, this week, YYYY-MM-DD) selects runs; anything else stays free text. - server: dispatch protocol.Search to stores[0].Search; read-only and unconfirmed. - cli: add `pipelines search QUERY [--type KIND] [--limit N] [--json]`, help text and a BROWSE line. - store: add OpenReadOnly so the live-database check never runs DDL. - docs: document the grammar, kinds, ranking and bounds in docs/cli.md, scope the TUI omnisearch to pipelines in docs/ui-ux-review.md, and add a search bullet to the packaged operations reference. - tests: protocol round trip, store/ranking/term-parsing/limit/scan-bound unit tests, a server end-to-end test, and an env-guarded live check. No new dependencies; go.mod/go.sum unchanged.
This commit is contained in:
+50
-1
@@ -37,9 +37,10 @@ type options struct {
|
||||
url, name, prompt, template, workspace, paths, key, opencode, model string
|
||||
output string
|
||||
conflict string
|
||||
kind string
|
||||
all bool
|
||||
json, source, noOpen, yes, allow, createOnly, force, wait bool
|
||||
version, expected int
|
||||
version, expected, limit int
|
||||
timeout, waitTimeout time.Duration
|
||||
}
|
||||
|
||||
@@ -99,6 +100,9 @@ func (a App) flags(command string) (*flag.FlagSet, *options) {
|
||||
f.DurationVar(&o.waitTimeout, "wait-timeout", 0, "Client limit for --wait after the run is admitted (0 waits until terminal); separate from per-request --timeout")
|
||||
case "runs":
|
||||
f.StringVar(&o.name, "pipeline", "", "Filter by exact pipeline name or ID")
|
||||
case "search":
|
||||
f.StringVar(&o.kind, "type", "", "Narrow to one kind: "+strings.Join(protocol.SearchKinds, ", "))
|
||||
f.IntVar(&o.limit, "limit", 0, "Maximum results (default 50, max 200)")
|
||||
case "retry":
|
||||
f.BoolVar(&o.yes, "yes", false, "Confirm retry without an interactive prompt")
|
||||
f.StringVar(&o.key, "request-key", "", "Idempotency key (default: generated unique key)")
|
||||
@@ -697,6 +701,31 @@ func (a App) Run(ctx context.Context, args []string) error {
|
||||
return err
|
||||
case "import":
|
||||
return a.importBundle(ctx, o, f.Args(), call)
|
||||
case "search":
|
||||
query := strings.Join(pos, " ")
|
||||
if strings.TrimSpace(query) == "" {
|
||||
return fmt.Errorf("search requires a query; use pipelines help search")
|
||||
}
|
||||
r, err := call(protocol.Message{Type: protocol.Search, Search: &protocol.SearchRequest{Query: query, Kind: o.kind, Limit: o.limit}})
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if r.SearchResults == nil {
|
||||
return fmt.Errorf("server did not return search results; update pipelines-server")
|
||||
}
|
||||
if o.json {
|
||||
return a.output(r.SearchResults)
|
||||
}
|
||||
if len(r.SearchResults.Results) == 0 {
|
||||
fmt.Fprintln(a.Out, "No matches")
|
||||
}
|
||||
for _, hit := range r.SearchResults.Results {
|
||||
fmt.Fprintf(a.Out, "%s\t%s\t%d\t%s\t%s\n", hit.Kind, hit.Target, hit.Score, hit.MatchedField, searchLabel(hit))
|
||||
}
|
||||
if r.SearchResults.Truncated {
|
||||
fmt.Fprintf(a.Err, "Results truncated (cap %d, scan bound %d bytes)\n", r.SearchResults.Cap, r.SearchResults.ScanBoundBytes)
|
||||
}
|
||||
return nil
|
||||
case "show", "versions":
|
||||
value, err := one()
|
||||
if err != nil {
|
||||
@@ -819,6 +848,26 @@ func (a App) output(value any) error {
|
||||
return encoder.Encode(value)
|
||||
}
|
||||
|
||||
// searchLabel renders one search hit's compact human line. Each kind exposes a
|
||||
// different typed payload; the target stays the navigable identity.
|
||||
func searchLabel(hit protocol.SearchResult) string {
|
||||
switch {
|
||||
case hit.Pipeline != nil:
|
||||
return fmt.Sprintf("%s · v%d · %d stages", hit.Pipeline.Name, hit.Pipeline.Version, hit.Pipeline.Stages)
|
||||
case hit.Version != nil:
|
||||
return fmt.Sprintf("pipeline %d · v%d · %s", hit.Version.PipelineID, hit.Version.Version, hit.Version.ContentHash)
|
||||
case hit.Run != nil:
|
||||
return fmt.Sprintf("run %d · %s · %s", hit.Run.ID, hit.Run.PipelineName, hit.Run.Status)
|
||||
case hit.Step != nil:
|
||||
return fmt.Sprintf("run %d · step %d · %s · %s", hit.Step.RunID, hit.Step.Sequence, hit.Step.Stage, hit.Step.Outcome)
|
||||
case hit.Field != nil:
|
||||
return fmt.Sprintf("run %d · step %d · %s: %s", hit.Field.RunID, hit.Field.Sequence, hit.Field.Field, hit.Field.Snippet)
|
||||
case hit.Artifact != nil:
|
||||
return fmt.Sprintf("run %d · step %d · %s · %s", hit.Artifact.RunID, hit.Artifact.Sequence, hit.Artifact.Name, hit.Artifact.ContentType)
|
||||
}
|
||||
return ""
|
||||
}
|
||||
|
||||
type callFunc func(protocol.Message) (protocol.Message, error)
|
||||
type resolveFunc func(string) (protocol.PipelineSummary, error)
|
||||
|
||||
|
||||
@@ -10,6 +10,7 @@ var usage = map[string]string{
|
||||
"validate": "validate <draft.md> [--json]",
|
||||
"submit": "submit <draft.md> [--name NAME] [--create-only] [--yes] [--json]",
|
||||
"list": "list [--json]",
|
||||
"search": "search QUERY [--type KIND] [--limit N] [--json]",
|
||||
"show": "show <name|id> [--version N] [--json]",
|
||||
"versions": "versions <name|id> [--json]",
|
||||
"export": "export [name|id ...] [--output FILE.zip] [--all] [--version N]",
|
||||
@@ -44,6 +45,7 @@ var notes = map[string]string{
|
||||
"retry": "Start a new attempt of a failed run with the same initial input, directory, pipeline version, and edit scope. Original history is retained. Already-completed side effects are not undone. --wait/--wait-timeout behave as for run: a reached wait limit leaves the new run active; inspect read-only with `inspect <run-id> --json`, or reattach with --wait and the original --request-key instead of starting a duplicate retry.",
|
||||
"debug": "Open a fresh configured harness conversation to investigate a run using inspect/show/runs CLI queries. --harness opencode|pi|nvim chooses another configured harness or read-only nvim packet. Does not resume implementation or retry. --json returns the prompt without launching anything.",
|
||||
"rpc": "Accepts a JSON protocol envelope; '-' reads stdin. Every TUI server operation is available here too. Mutating commands are not dry runs.",
|
||||
"search": "One read-only query over pipelines, versions, runs, steps, field text and artifacts. QUERY is free text, a bare status word (queued, running, succeeded, failed, canceled, interrupted) selecting those runs, or a lone date expression (today, yesterday, this week [Monday 00:00 local], or YYYY-MM-DD) selecting the runs created in that window. --type is the only narrowing mechanism and takes one kind: pipeline, version, run, step, field or artifact; an unknown kind is an error. Ranking: an exact name match (3) beats a name substring (2) beats a body-text match (1); equal tiers break by recency, then a stable kind/target tie-break, and every hit reports score, matched_field and recency so a client can re-rank. Bounds: the result cap defaults to 50 and clamps to 200 (0 = default); every kind scans at most 2000 rows and field-text scanning is additionally capped at 2000 steps / 1 MiB; Truncated plus scanned_steps, scanned_bytes and scan_bound_bytes report when a bound applied. Targets are stable: pipeline:<id>, pipeline:<id>:v<version>, run:<id>, run:<id>:<sequence>, run:<id>:<sequence>:<field>, or an artifact URL.",
|
||||
}
|
||||
|
||||
var serviceHelp = map[string]string{
|
||||
|
||||
@@ -13,6 +13,7 @@ AUTHOR
|
||||
|
||||
BROWSE
|
||||
list List registered pipelines
|
||||
search QUERY Search pipelines, versions, runs, steps, field text, artifacts
|
||||
show <name|id> Inspect graph, settings, source and history
|
||||
versions <name|id> List immutable versions
|
||||
export [name|id ...] Select/export definitions as ZIP; one name prints Markdown
|
||||
|
||||
Reference in New Issue
Block a user