Console

Console

The built‑in console captures standard output and error streams and overlays them within your terminal UI. You can enable it when creating the renderer by setting useConsole to true and customise its size, colours and starting mode.

Toggle the console programmatically or via keyboard shortcuts. The default keybinding is Ctrl+D. You can choose the position (top or bottom), specify width and height percentages and configure a title. Logs printed via console.log will appear in the overlay.

const renderer = await createCliRenderer({
  useConsole: true,
  consoleOptions: {
    title: "Runtime Logs",
    startInDebugMode: true,
    position: "bottom",
    height: 10,
  },
})
renderer.console.show()
console.log("Renderer started")

The console can be toggled on and off at runtime:

renderer.console.toggle()

A useful pattern is to leave the console hidden for end users and only enable it in development builds or when a debug flag is set.