v0.38.0 58133ea

rpc.go RawHistoryFolder

1package agent
2
3import (
4	"bufio"
5	"context"
6	"encoding/json"
7	"errors"
8	"fmt"
9	"io"
10	"os"
11	"strings"
12	"sync"
13	"time"
14
15	"github.com/bnema/zut/packages/agent/extensions"
16	"github.com/bnema/zut/packages/agent/extproto"
17	"github.com/bnema/zut/packages/agent/modes"
18	"github.com/bnema/zut/packages/agent/tools"
19	"github.com/bnema/zut/packages/core"
20	"github.com/bnema/zut/packages/provider"
21)
22
23// runRPCMode implements the JSON-over-stdin/stdout RPC protocol.
24//
25// Wire format: one JSON object per line in both directions.
26//
27// Commands (stdin):
28//
29//	{"id":"1","type":"prompt","message":"hello","images":[]}
30//	{"id":"2","type":"abort"}
31//	{"id":"3","type":"compact"}
32//	{"id":"4","type":"get_state"}
33//	{"id":"5","type":"set_model","model":"claude-opus-4-5"}
34//	{"id":"6","type":"set_reasoning","reasoning":"max"}
35//	{"id":"6","type":"get_messages"}
36//	{"id":"7","type":"clear"}
37//	{"id":"8","type":"get_models"}
38//
39// Responses (stdout): {"type":"response","id":"1","command":"prompt","success":true}
40// Events (stdout): one JSON object per AgentEvent (same schema as --json mode).
41// Extensions may additionally emit ext_status with extension/key/level/text,
42// ext_widget with extension/id/position/title/lines, and ext_widget_clear
43// with extension/id when loaded extensions publish persistent UI state.
44//
45// Auth: if $ZUTCORE_RPC_TOKEN is set, the first command must be
46// {"type":"hello","token":"..."} or the connection is closed.
47func runRPCMode(ctx context.Context, args Args, version string) error {
48	if args.NoYolo {
49		fmt.Fprintln(os.Stderr, "warning: --no-yolo has no effect in rpc mode (no interactive prompt available); tools will run without confirmation")
50	}
51	r, err := Resolve(args, true)
52	if err != nil {
53		return err
54	}
55
56	// Construct the RPC event sink before extension startup. Alerts can
57	// arrive as soon as an extension is ready; rpcServer queues them until
58	// the command loop has started and, when configured, authenticated.
59	server := &rpcServer{
60		ctx:      ctx,
61		args:     args,
62		provider: r.Provider,
63		model:    r.Model,
64		out:      os.Stdout,
65		version:  version,
66	}
67
68	// Extensions: same lifecycle as interactive mode, minus the
69	// host-hooks integration. Notify/Display calls from extensions
70	// emit RPC events instead of TUI lines so any consumer can react.
71	extHooks := &rpcExtHooks{server: server}
72	extMgr := extensions.New(ZutHome(), r.CWD, version, r.Provider, r.Model, extHooks)
73	for _, e := range extMgr.LoadExplicit(ctx, args.Exts) {
74		fmt.Fprintln(os.Stderr, "extension load:", e)
75	}
76	if !args.NoExt {
77		for _, e := range extMgr.Discover(ctx) {
78			fmt.Fprintln(os.Stderr, "extension load:", e)
79		}
80	}
81	extMgr.WaitForReady(3 * time.Second)
82	defer extMgr.Stop(2 * time.Second)
83	r.MergeExtensionTools(&extToolAdapter{mgr: extMgr})
84
85	ag := r.NewAgent()
86	defer closeAgentLSP(ag)
87	server.agent = ag
88	ag.BeforeToolExecute = func(call provider.ToolCallBlock) (bool, string, json.RawMessage) {
89		r := extMgr.InterceptToolCall(ctx, call.ID, call.Name, call.Arguments)
90		if r.Block {
91			return false, r.Reason, nil
92		}
93		return true, "", r.ModifiedArgs
94	}
95	ag.BeforeTurnContext = func(turnCtx context.Context, step int) (bool, string, string) {
96		r := extMgr.InterceptTurnStart(turnCtx, step)
97		return !r.Block, r.Reason, r.Context
98	}
99	ag.BeforeAssistantMessage = func(text string) (bool, string, string) {
100		r := extMgr.InterceptAssistantMessage(ctx, text)
101		if r.Block {
102			return false, r.Reason, ""
103		}
104		return true, "", r.ReplaceText
105	}
106	ag.OnEvent = func(ev core.AgentEvent) { fanoutAgentEvent(extMgr, ev) }
107
108	// /reload-ext hot-reload callback (also triggered via rpc
109	// `reload_ext` if/when added). Rebuilds the tool registry on the
110	// current agent so freshly-registered extension tools become
111	// callable without restarting the rpc process.
112	adapter := &extToolAdapter{mgr: extMgr}
113	extMgr.SetOnReload(func() {
114		resolved, err := Resolve(args, true)
115		if err != nil {
116			return
117		}
118		resolved.MergeExtensionTools(adapter)
119		oldTools := ag.SetPromptConfig(resolved.SystemPrompt, resolved.ToolRegistry)
120		if closeErr := tools.CloseLSPManagers(oldTools); closeErr != nil {
121			fmt.Fprintln(os.Stderr, "reload LSP cleanup:", closeErr)
122		}
123	})
124
125	extMgr.EmitSessionEvent("session_start", nil, nil)
126
127	return server.run(os.Stdin)
128}
129
130// rpcExtHooks implements extensions.HostHooks for the headless RPC
131// loop. Notify and Display surface as `event` frames so any RPC
132// client can render them; Submit and Insert are no-ops because the
133// RPC loop has no editor and the prompt comes from the client.
134type rpcExtHooks struct {
135	server *rpcServer
136}
137
138func (h *rpcExtHooks) Notify(extName, level, message string) {
139	if h.server != nil {
140		h.server.writeExtensionEvent(map[string]any{
141			"type":      "ext_notify",
142			"extension": extName,
143			"level":     level,
144			"message":   message,
145		})
146	}
147}
148func (h *rpcExtHooks) Alert(extName string, alert extproto.AlertRequest) {
149	if h.server != nil {
150		h.server.writeExtensionEvent(map[string]any{
151			"type":      "ext_alert",
152			"extension": extName,
153			"kind":      alert.Kind,
154			"reason":    alert.Reason,
155		})
156	}
157}
158func (h *rpcExtHooks) Display(extName, text string) {
159	if h.server != nil {
160		h.server.writeExtensionEvent(map[string]any{
161			"type":      "ext_display",
162			"extension": extName,
163			"text":      text,
164		})
165	}
166}
167func (h *rpcExtHooks) ClearNotes(extName string) {
168	if h.server != nil {
169		h.server.writeExtensionEvent(map[string]any{
170			"type":      "ext_clear_notes",
171			"extension": extName,
172		})
173	}
174}
175func (h *rpcExtHooks) Submit(string)                                        {} // ignored in rpc mode
176func (h *rpcExtHooks) SubmitSlash(string)                                   {} // ignored in rpc mode
177func (h *rpcExtHooks) Insert(string)                                        {} // ignored in rpc mode
178func (h *rpcExtHooks) OpenPanel(string, extproto.PanelSpec)                 {}
179func (h *rpcExtHooks) UpdatePanel(string, string, string, []string, string) {}
180func (h *rpcExtHooks) ClosePanel(string, string)                            {}
181func (h *rpcExtHooks) SetStatus(extName, key, level, text string) {
182	if h.server != nil {
183		h.server.writeExtensionEvent(map[string]any{
184			"type": "ext_status", "extension": extName, "key": key, "level": level, "text": text,
185		})
186	}
187}
188func (h *rpcExtHooks) SetWidget(extName, id, position, title string, lines []string) {
189	if h.server != nil {
190		h.server.writeExtensionEvent(map[string]any{
191			"type": "ext_widget", "extension": extName, "id": id, "position": position, "title": title, "lines": lines,
192		})
193	}
194}
195func (h *rpcExtHooks) ClearWidget(extName, id string) {
196	if h.server != nil {
197		h.server.writeExtensionEvent(map[string]any{
198			"type": "ext_widget_clear", "extension": extName, "id": id,
199		})
200	}
201}
202
203func (h *rpcExtHooks) ClearExtensionChrome(extName string) {
204	if h.server != nil {
205		h.server.writeExtensionEvent(map[string]any{
206			"type": "ext_chrome_clear", "extension": extName,
207		})
208	}
209}
210
211const maxPendingRPCExtEvents = 64
212
213type rpcServer struct {
214	ctx      context.Context
215	args     Args
216	agent    *core.Agent
217	provider string
218	model    string
219	out      io.Writer
220	version  string
221
222	writeMu          sync.Mutex
223	turnMu           sync.Mutex // serialises one prompt at a time
224	activeCancel     context.CancelFunc
225	started          bool
226	authed           bool
227	pendingExtEvents [][]byte
228
229	// inFlight tracks long-running command goroutines so run() can
230	// wait for them before returning when stdin closes. Without this,
231	// piping a single 'prompt' command into 'zut rpc' would race the
232	// process exit against the agent loop and the prompt would never
233	// produce output.
234	inFlight sync.WaitGroup
235}
236
237// run reads NDJSON commands from in and dispatches them. Returns when
238// in is closed AND every in-flight long-running command (prompt /
239// compact) has finished, so a quick `echo cmd | zut rpc` invocation
240// still produces full output before the process exits.
241func (s *rpcServer) run(in io.Reader) error {
242	requireToken := os.Getenv("ZUTCORE_RPC_TOKEN") != ""
243	s.writeMu.Lock()
244	s.started = true
245	s.authed = !requireToken
246	if s.authed {
247		s.flushPendingExtEventsLocked()
248	}
249	s.writeMu.Unlock()
250
251	sc := bufio.NewScanner(in)
252	sc.Buffer(make([]byte, 0, 64*1024), 16*1024*1024)
253	for sc.Scan() {
254		line := strings.TrimSpace(sc.Text())
255		if line == "" {
256			continue
257		}
258		var head struct {
259			Type string `json:"type"`
260			ID   string `json:"id,omitempty"`
261		}
262		if err := json.Unmarshal([]byte(line), &head); err != nil {
263			s.writeError("", "", fmt.Sprintf("malformed json: %v", err))
264			continue
265		}
266		if !s.isAuthed() {
267			if head.Type != "hello" {
268				s.writeError(head.ID, head.Type, "auth required: send hello with token first")
269				continue
270			}
271			var hello struct {
272				Token string `json:"token"`
273			}
274			_ = json.Unmarshal([]byte(line), &hello)
275			if hello.Token != os.Getenv("ZUTCORE_RPC_TOKEN") {
276				s.writeError(head.ID, head.Type, "invalid token")
277				return fmt.Errorf("rpc: bad auth token")
278			}
279			s.authenticate(head.ID, head.Type)
280			continue
281		}
282		s.dispatch(head.Type, head.ID, []byte(line))
283	}
284	err := sc.Err()
285	s.inFlight.Wait()
286	return err
287}
288
289func resolveRPCModel(providerName, modelID string) (provider.Model, error) {
290	model, err := provider.FindModel(providerName, modelID)
291	if err == nil {
292		return model, nil
293	}
294	if providerName == provider.ProviderOpenCodeGo && provider.AcceptsUnlistedModels(providerName) {
295		return provider.DynamicOpenCodeGoModel(providerName, modelID, ""), nil
296	}
297	return provider.Model{}, err
298}
299
300// dispatch routes a command. Long-running commands (prompt, compact)
301// run on their own goroutine so the read loop stays responsive.
302func (s *rpcServer) dispatch(cmd, id string, raw []byte) {
303	switch cmd {
304	case "hello":
305		s.writeResponse(id, cmd, map[string]any{
306			"protocol_version": 1,
307			"version":          s.version,
308			"provider":         s.provider,
309			"model":            s.model,
310		})
311	case "prompt":
312		var req struct {
313			Message string `json:"message"`
314			Images  []struct {
315				MimeType string `json:"mime_type"`
316				Data     []byte `json:"data"`
317			} `json:"images"`
318		}
319		if err := json.Unmarshal(raw, &req); err != nil {
320			s.writeError(id, cmd, err.Error())
321			return
322		}
323		s.inFlight.Add(1)
324		go func() {
325			defer s.inFlight.Done()
326			s.runPrompt(id, req.Message, req.Images)
327		}()
328
329	case "abort":
330		if c := s.takeCancel(); c != nil {
331			c()
332		}
333		s.writeResponse(id, cmd, nil)
334
335	case "compact":
336		s.inFlight.Add(1)
337		go func() {
338			defer s.inFlight.Done()
339			s.runCompact(id)
340		}()
341
342	case "get_state":
343		s.writeResponse(id, cmd, s.snapshotState())
344
345	case "get_messages":
346		s.writeResponse(id, cmd, map[string]any{
347			"messages": messagesToJSON(s.agent.Messages()),
348		})
349
350	case "clear":
351		s.agent.SetMessages(nil)
352		s.writeResponse(id, cmd, nil)
353
354	case "set_model":
355		if !s.turnMu.TryLock() {
356			s.writeError(id, cmd, "runtime is busy")
357			return
358		}
359		defer s.turnMu.Unlock()
360
361		var req struct {
362			Model string `json:"model"`
363		}
364		if err := json.Unmarshal(raw, &req); err != nil {
365			s.writeError(id, cmd, err.Error())
366			return
367		}
368		model := strings.TrimSpace(req.Model)
369		if model == "" {
370			s.writeError(id, cmd, "model must not be empty")
371			return
372		}
373		metadata, err := resolveRPCModel(s.provider, model)
374		if err != nil {
375			s.writeError(id, cmd, err.Error())
376			return
377		}
378		if setter, ok := s.agent.Client.(provider.ModelMetadataSetter); ok {
379			setter.SetModelMetadata(metadata)
380		}
381		if metadata.ContextWindow > 0 {
382			s.agent.ContextWindow = metadata.ContextWindow
383		}
384		if metadata.MaxOutput > 0 {
385			s.agent.MaxTokens = metadata.MaxOutput
386		}
387		s.agent.Model = model
388		s.model = model
389		s.writeResponse(id, cmd, map[string]any{"model": model})
390
391	case "set_reasoning":
392		var req struct {
393			Reasoning string `json:"reasoning"`
394		}
395		if err := json.Unmarshal(raw, &req); err != nil {
396			s.writeError(id, cmd, err.Error())
397			return
398		}
399		reasoning := provider.NormalizeReasoning(req.Reasoning)
400		switch reasoning {
401		case "", "minimum", "low", "medium", "high", "xhigh", "max":
402		default:
403			s.writeError(id, cmd, "reasoning must be off|minimum|low|medium|high|xhigh|max")
404			return
405		}
406		s.agent.Reasoning = reasoning
407		s.writeResponse(id, cmd, map[string]any{"reasoning": reasoning})
408
409	case "get_models":
410		out := []map[string]any{}
411		for _, m := range provider.ModelsForProvider(s.provider) {
412			out = append(out, map[string]any{
413				"id":             m.ID,
414				"provider":       m.Provider,
415				"context_window": m.ContextWindow,
416				"max_output":     m.MaxOutput,
417				"reasoning":      m.Reasoning,
418			})
419		}
420		s.writeResponse(id, cmd, map[string]any{"models": out})
421
422	case "ping":
423		s.writeResponse(id, cmd, map[string]any{"pong": true})
424
425	default:
426		s.writeError(id, cmd, "unknown command")
427	}
428}
429
430// runPrompt executes a single prompt turn and streams events out.
431// Holds turnMu so a second concurrent prompt blocks until this one
432// finishes; the user can abort with the abort command.
433func (s *rpcServer) runPrompt(id, message string, images []struct {
434	MimeType string `json:"mime_type"`
435	Data     []byte `json:"data"`
436}) {
437	s.turnMu.Lock()
438	defer s.turnMu.Unlock()
439
440	subCtx, cancel := context.WithCancel(s.ctx)
441	s.setCancel(cancel)
442	defer s.setCancel(nil)
443
444	s.writeResponse(id, "prompt", map[string]any{"started": true})
445
446	imgs := make([]provider.ImageBlock, 0, len(images))
447	for _, im := range images {
448		imgs = append(imgs, provider.ImageBlock{MimeType: im.MimeType, Data: im.Data})
449	}
450
451	err := s.agent.Prompt(subCtx, message, imgs, func(ev core.AgentEvent) {
452		// EvDone is emitted by the agent loop and we re-emit our own
453		// 'done' below; suppressing it here avoids duplicate frames.
454		if _, ok := ev.(core.EvDone); ok {
455			return
456		}
457		s.writeEvent(modes.EventToJSON(ev))
458	})
459	// Don't emit a stand-alone error event for cancellation; the prior
460	// turn_end with stop=aborted already carries that signal.
461	if err != nil && !errors.Is(err, context.Canceled) {
462		s.writeEvent(map[string]any{"type": "error", "message": err.Error()})
463	}
464	s.writeEvent(map[string]any{"type": "done"})
465}
466
467// runCompact mirrors runPrompt but for compaction.
468func (s *rpcServer) runCompact(id string) {
469	s.turnMu.Lock()
470	defer s.turnMu.Unlock()
471
472	subCtx, cancel := context.WithCancel(s.ctx)
473	s.setCancel(cancel)
474	defer s.setCancel(nil)
475
476	s.writeResponse(id, "compact", map[string]any{"started": true})
477	summary, err := s.agent.CompactWithEvents(subCtx, 4, func(ev core.AgentEvent) {
478		s.writeEvent(modes.EventToJSON(ev))
479	})
480	if err != nil {
481		if !errors.Is(err, context.Canceled) {
482			s.writeEvent(map[string]any{"type": "error", "message": err.Error()})
483		}
484		return
485	}
486	s.writeEvent(map[string]any{
487		"type":    "compact_done",
488		"summary": summary,
489	})
490}
491
492// snapshotState builds the get_state response.
493func (s *rpcServer) snapshotState() map[string]any {
494	cum := s.agent.Cost()
495	return map[string]any{
496		"provider":      s.provider,
497		"model":         s.model,
498		"reasoning":     s.agent.Reasoning,
499		"cwd":           s.args.CWD,
500		"message_count": len(s.agent.Messages()),
501		"busy":          s.activeCancel != nil,
502		"usage": map[string]any{
503			"input":                 cum.InputTokens,
504			"output":                cum.OutputTokens,
505			"reasoning":             rpcReasoningTokens(cum),
506			"cache_read":            cum.CacheReadTokens,
507			"cache_write":           cum.CacheWriteTokens,
508			"cache_measured_prompt": cum.CacheMeasuredPromptTokens,
509			"cache_measured_read":   cum.CacheMeasuredReadTokens,
510			"cost_usd":              cum.CostUSD,
511		},
512	}
513}
514
515func rpcReasoningTokens(usage provider.Usage) any {
516	if !usage.ReasoningTokensKnown {
517		return nil
518	}
519	return usage.ReasoningTokens
520}
521
522// ---- write helpers (single-line JSON, mutex-guarded) ----
523
524func (s *rpcServer) writeResponse(id, cmd string, data any) {
525	frame := map[string]any{
526		"type":    "response",
527		"command": cmd,
528		"success": true,
529	}
530	if id != "" {
531		frame["id"] = id
532	}
533	if data != nil {
534		frame["data"] = data
535	}
536	s.write(frame)
537}
538
539func (s *rpcServer) writeError(id, cmd, msg string) {
540	frame := map[string]any{
541		"type":    "response",
542		"command": cmd,
543		"success": false,
544		"error":   msg,
545	}
546	if id != "" {
547		frame["id"] = id
548	}
549	s.write(frame)
550}
551
552func (s *rpcServer) writeEvent(payload map[string]any) {
553	s.write(payload)
554}
555
556func (s *rpcServer) writeExtensionEvent(payload map[string]any) {
557	b, err := json.Marshal(payload)
558	if err != nil {
559		return
560	}
561	s.writeMu.Lock()
562	defer s.writeMu.Unlock()
563	if !s.started || !s.authed {
564		if len(s.pendingExtEvents) < maxPendingRPCExtEvents {
565			s.pendingExtEvents = append(s.pendingExtEvents, b)
566		}
567		return
568	}
569	s.writeLocked(b)
570}
571
572func (s *rpcServer) flushPendingExtEventsLocked() {
573	for _, b := range s.pendingExtEvents {
574		s.writeLocked(b)
575	}
576	s.pendingExtEvents = nil
577}
578
579func (s *rpcServer) isAuthed() bool {
580	s.writeMu.Lock()
581	defer s.writeMu.Unlock()
582	return s.authed
583}
584
585func (s *rpcServer) authenticate(id, cmd string) {
586	frame := map[string]any{
587		"type":    "response",
588		"command": cmd,
589		"success": true,
590		"data": map[string]any{
591			"protocol_version": 1,
592			"version":          s.version,
593			"provider":         s.provider,
594			"model":            s.model,
595		},
596	}
597	if id != "" {
598		frame["id"] = id
599	}
600	b, err := json.Marshal(frame)
601	if err != nil {
602		return
603	}
604	s.writeMu.Lock()
605	defer s.writeMu.Unlock()
606	s.authed = true
607	s.writeLocked(b)
608	s.flushPendingExtEventsLocked()
609}
610
611func (s *rpcServer) write(v any) {
612	b, err := json.Marshal(v)
613	if err != nil {
614		return
615	}
616	s.writeMu.Lock()
617	defer s.writeMu.Unlock()
618	s.writeLocked(b)
619}
620
621func (s *rpcServer) writeLocked(b []byte) {
622	_, _ = s.out.Write(b)
623	_, _ = s.out.Write([]byte("\n"))
624}
625
626func (s *rpcServer) setCancel(c context.CancelFunc) {
627	s.writeMu.Lock()
628	s.activeCancel = c
629	s.writeMu.Unlock()
630}
631
632func (s *rpcServer) takeCancel() context.CancelFunc {
633	s.writeMu.Lock()
634	defer s.writeMu.Unlock()
635	c := s.activeCancel
636	s.activeCancel = nil
637	return c
638}
639
640// messagesToJSON serialises a transcript using the same schema as the
641// --json event mode for cross-format consistency.
642func messagesToJSON(msgs []provider.Message) []map[string]any {
643	out := make([]map[string]any, 0, len(msgs))
644	for _, m := range msgs {
645		out = append(out, map[string]any{
646			"role":    string(m.Role),
647			"content": modes.ContentToJSON(m.Content),
648			"time":    m.Time,
649		})
650	}
651	return out
652}

Keyboard shortcuts

Single-key shortcuts are on. ctrl k and esc work whatever this says.

ctrl k :
go to a section, branch, tag, file or repository
?
this list
j k
move the row cursor down / up
enter
open the row under the cursor; on Files, a directory opens or closes in place
↑ ↓ ← → home end
in the file tree (focus on a row): previous / next row, close / open a directory or go to its parent / first entry, first / last row. They never open a file
l h
on Files: open a directory or a file / close a directory or go up to its parent, then to the parent page. Elsewhere: into the side panel (on a merge request, its files) / back to the content; there j k move between its controls
g g G
first / last row
/
filter the list; on Files, find a file anywhere in the repository (esc clears, enter opens the best match)
b
switch branch or tag
g s g f g c g b g m g i g r g a
tabs: summary, files, commits, branches & tags, merge requests, issues, releases, actions (when available)
g h
home
w
wide mode: use the whole width of the screen, or not (remembered)
y
copy a permalink pinned to the commit
d u x
diff: split / unified / collapse or expand all
e E
diff: the whole file in view / every file, with the lines the hunks hide
n
merge request: next note in the diff
esc
close a dialog, leave a field

Branches 1

Tags 476

↑↓ moveenter openesc close