orka.tui package

TUI package - exports the main interface class for backward compatibility.

class orka.tui.DashboardScreen(data_manager: Any, **kwargs: Any)

Bases: BaseOrKaScreen

Dashboard screen showing overview of memory system.

can_focus: bool = False

Widget may receive focus.

can_focus_children: bool = True

Widget’s children may receive focus.

compose_content() → Iterable[Widget]

Compose the dashboard layout.

refresh_data() → None

Refresh dashboard data.

class orka.tui.HealthScreen(data_manager: Any, **kwargs: Any)

Bases: BaseOrKaScreen

Screen for system health monitoring.

can_focus: bool = False

Widget may receive focus.

can_focus_children: bool = True

Widget’s children may receive focus.

compose_content() → Iterable[Widget]

Compose the health monitoring layout.

refresh_data() → None

Refresh health monitoring data.

class orka.tui.HealthWidget(data_manager: Any, **kwargs: Any)

Bases: Container

Widget for displaying system health metrics.

can_focus: bool = False

Widget may receive focus.

can_focus_children: bool = True

Widget’s children may receive focus.

compose() → Any

Compose the health widget.

update_health()

Update health display with unified health calculations.

class orka.tui.LogsWidget(data_manager: Any, **kwargs: Any)

Bases: DataTable

Enhanced widget for displaying memory logs with orchestration priority.

can_focus: bool = True

Widget may receive focus.

can_focus_children: bool = True

Widget’s children may receive focus.

update_data()

Update logs with unified filtering - show overview of recent orchestration and system logs.

class orka.tui.LongMemoryScreen(data_manager: Any, **kwargs: Any)

Bases: BaseOrKaScreen

Screen for viewing long-term memory entries.

can_focus: bool = False

Widget may receive focus.

can_focus_children: bool = True

Widget’s children may receive focus.

compose_content() → Iterable[Widget]

Compose the long memory layout.

on_memory_table_widget_memory_selected(message: MemorySelected) → None

Handle memory selection to show content and metadata in lower panel.

refresh_data() → None

Refresh long memory data.

class orka.tui.MemoryLogsScreen(data_manager: Any, **kwargs: Any)

Bases: BaseOrKaScreen

Screen for viewing memory system logs.

can_focus: bool = False

Widget may receive focus.

can_focus_children: bool = True

Widget’s children may receive focus.

compose_content() → Iterable[Widget]

Compose the memory logs layout.

on_memory_table_widget_memory_selected(message: MemorySelected) → None

Handle memory selection to show content and metadata in lower panel.

refresh_data() → None

Refresh memory logs data.

class orka.tui.MemoryTableWidget(data_manager: Any, memory_type: str = 'all', **kwargs: Any)

Bases: DataTable

Custom data table for displaying memory entries with checkbox selection.

class MemorySelected(memory_data: Dict[str, Any] | None, row_index: int)

Bases: Message

Message sent when a memory row is selected.

time

bubble: ClassVar[bool] = True

handler_name: ClassVar[str] = 'on_memory_table_widget_memory_selected'

Name of the default message handler.

no_dispatch: ClassVar[bool] = False

verbose: ClassVar[bool] = False

can_focus: bool = True

Widget may receive focus.

can_focus_children: bool = True

Widget’s children may receive focus.

on_data_table_cell_selected(event: CellSelected) → None

Handle cell selection to toggle checkbox - alternative approach.

on_data_table_row_selected(event: RowSelected) → None

Handle row selection to toggle checkbox.

update_data(memory_type: str = 'all') → None

class orka.tui.ModernTUIInterface

Bases: object

Modern TUI interface for OrKa memory monitoring.

run(args: Any) → int

Main entry point for the TUI interface.

class orka.tui.OrKaTextualApp(data_manager)

Bases: App

Modern Textual-native OrKa monitoring application.

BINDINGS: ClassVar[list[BindingType]] = [Binding(key='1', action='show_dashboard', description='Dashboard', show=True, key_display=None, priority=False, tooltip='', id=None, system=False), Binding(key='2', action='show_short_memory', description='Short Memory', show=True, key_display=None, priority=False, tooltip='', id=None, system=False), Binding(key='3', action='show_long_memory', description='Long Memory', show=True, key_display=None, priority=False, tooltip='', id=None, system=False), Binding(key='4', action='show_memory_logs', description='Memory Logs', show=True, key_display=None, priority=False, tooltip='', id=None, system=False), Binding(key='5', action='show_health', description='Health', show=True, key_display=None, priority=False, tooltip='', id=None, system=False), Binding(key='q', action='quit', description='Quit', show=True, key_display=None, priority=False, tooltip='', id=None, system=False), Binding(key='ctrl+p', action='command_palette', description='Palette', show=True, key_display=None, priority=False, tooltip='', id=None, system=False), Binding(key='r', action='refresh', description='Refresh', show=True, key_display=None, priority=False, tooltip='', id=None, system=False), Binding(key='f', action='toggle_fullscreen', description='Fullscreen', show=True, key_display=None, priority=False, tooltip='', id=None, system=False)]

The default key bindings.

CSS_PATH: ClassVar[CSSPathType | None] = 'textual_styles.tcss'

File paths to load CSS from.

SUB_TITLE: str | None = 'Real-time Memory System Monitoring'

A class variable to set the default sub-title for the application.

To update the sub-title while the app is running, you can set the [sub_title][textual.app.App.sub_title] attribute. See also [the Screen.SUB_TITLE attribute][textual.screen.Screen.SUB_TITLE].

TITLE: str | None = 'OrKa Memory Monitor'

A class variable to set the default title for the application.

To update the title while the app is running, you can set the [title][textual.app.App.title] attribute. See also [the Screen.TITLE attribute][textual.screen.Screen.TITLE].

action_refresh() → None

Force refresh current screen.

action_show_dashboard() → None

Switch to dashboard view.

action_show_health() → None

Switch to health monitoring view.

action_show_long_memory() → None

Switch to long memory view.

action_show_memory_logs() → None

Switch to memory logs view.

action_show_short_memory() → None

Switch to short memory view.

action_toggle_fullscreen() → None

Toggle fullscreen mode.

on_mount() → None

Initialize the application.

on_screen_resume(event) → None

Handle screen resume events.

refresh_current_screen() → None

Refresh the current screen’s data.

class orka.tui.ShortMemoryScreen(data_manager: Any, **kwargs: Any)

Bases: BaseOrKaScreen

Screen for viewing short-term memory entries.

can_focus: bool = False

Widget may receive focus.

can_focus_children: bool = True

Widget’s children may receive focus.

compose_content() → Iterable[Widget]

Compose the short memory layout.

on_memory_table_widget_memory_selected(message: MemorySelected) → None

Handle memory selection to show content and metadata in lower panel.

refresh_data() → None

Refresh short memory data.

class orka.tui.StatsWidget(data_manager: Any, **kwargs: Any)

Bases: Static

Widget for displaying memory statistics.

can_focus: bool = False

Widget may receive focus.

can_focus_children: bool = True

Widget’s children may receive focus.

update_stats()

Update the stats display.

Submodules

• orka.tui.components module
  • ComponentBuilder
    • ComponentBuilder.stats
    • ComponentBuilder.memory_data
    • ComponentBuilder.performance_history
    • ComponentBuilder.memory_logger
    • ComponentBuilder.backend
    • ComponentBuilder.running
    • ComponentBuilder.create_compact_header()
    • ComponentBuilder.create_compact_stats_panel()
    • ComponentBuilder.create_compact_memories_panel()
    • ComponentBuilder.create_compact_performance_panel()
    • ComponentBuilder.create_compact_footer()
    • ComponentBuilder.create_header()
    • ComponentBuilder.create_stats_panel()
    • ComponentBuilder.create_footer()
    • ComponentBuilder.create_recent_memories_panel()
    • ComponentBuilder.create_simple_chart()
    • ComponentBuilder.create_memory_browser()
    • ComponentBuilder.create_performance_view()
    • ComponentBuilder.create_performance_panel()
    • ComponentBuilder.create_config_view()
• orka.tui.data_manager module
  • MemoryLoggerProtocol
    • MemoryLoggerProtocol.get_memory_stats()
    • MemoryLoggerProtocol.get_recent_stored_memories()
    • MemoryLoggerProtocol.search_memories()
    • MemoryLoggerProtocol.get_performance_metrics()
  • MemoryStats
    • MemoryStats.update()
    • MemoryStats.get_trend()
    • MemoryStats.get_rate()
  • DataManager
    • DataManager.init_memory_logger()
    • DataManager.update_data()
    • DataManager.is_short_term_memory()
    • DataManager.get_filtered_memories()
    • DataManager.get_memory_distribution()
    • DataManager.get_unified_stats()
    • DataManager.debug_memory_data()
• orka.tui.fallback module
  • FallbackInterface
    • FallbackInterface.run_basic_fallback()
    • FallbackInterface.basic_json_watch()
    • FallbackInterface.basic_display_watch()
• orka.tui.interface module
  • ModernTUIInterface
    • ModernTUIInterface.run()
• orka.tui.layouts module
  • LayoutManager
    • LayoutManager.create_dashboard()
    • LayoutManager.create_memory_browser()
    • LayoutManager.create_performance_view()
    • LayoutManager.create_config_view()
    • LayoutManager.get_view()
• orka.tui.textual_app module
  • OrKaTextualApp
    • OrKaTextualApp.TITLE
    • OrKaTextualApp.SUB_TITLE
    • OrKaTextualApp.BINDINGS
    • OrKaTextualApp.CSS_PATH
    • OrKaTextualApp.on_mount()
    • OrKaTextualApp.refresh_current_screen()
    • OrKaTextualApp.action_show_dashboard()
    • OrKaTextualApp.action_show_short_memory()
    • OrKaTextualApp.action_show_long_memory()
    • OrKaTextualApp.action_show_memory_logs()
    • OrKaTextualApp.action_show_health()
    • OrKaTextualApp.action_refresh()
    • OrKaTextualApp.action_toggle_fullscreen()
    • OrKaTextualApp.on_screen_resume()
    • OrKaTextualApp.features
    • OrKaTextualApp.mouse_over
    • OrKaTextualApp.mouse_captured
    • OrKaTextualApp.use_command_palette
    • OrKaTextualApp.theme_variables
    • OrKaTextualApp.scroll_sensitivity_x
    • OrKaTextualApp.scroll_sensitivity_y
    • OrKaTextualApp.devtools
    • OrKaTextualApp.theme_changed_signal
    • OrKaTextualApp.app_suspend_signal
    • OrKaTextualApp.app_resume_signal
    • OrKaTextualApp.animation_level
    • OrKaTextualApp.supports_smooth_scrolling
    • OrKaTextualApp.styles
    • OrKaTextualApp.message_signal
• orka.tui.textual_screens module
  • BaseOrKaScreen
    • BaseOrKaScreen.compose()
    • BaseOrKaScreen.compose_content()
    • BaseOrKaScreen.on_mount()
    • BaseOrKaScreen.refresh_data()
    • BaseOrKaScreen.can_focus
    • BaseOrKaScreen.can_focus_children
  • DashboardScreen
    • DashboardScreen.compose_content()
    • DashboardScreen.refresh_data()
    • DashboardScreen.can_focus
    • DashboardScreen.can_focus_children
    • DashboardScreen.screen_layout_refresh_signal
    • DashboardScreen.bindings_updated_signal
    • DashboardScreen.text_selection_started_signal
    • DashboardScreen.highlight_style
    • DashboardScreen.absolute_offset
    • DashboardScreen.styles
    • DashboardScreen.message_signal
  • ShortMemoryScreen
    • ShortMemoryScreen.compose_content()
    • ShortMemoryScreen.on_memory_table_widget_memory_selected()
    • ShortMemoryScreen.refresh_data()
    • ShortMemoryScreen.can_focus
    • ShortMemoryScreen.can_focus_children
    • ShortMemoryScreen.screen_layout_refresh_signal
    • ShortMemoryScreen.bindings_updated_signal
    • ShortMemoryScreen.text_selection_started_signal
    • ShortMemoryScreen.highlight_style
    • ShortMemoryScreen.absolute_offset
    • ShortMemoryScreen.styles
    • ShortMemoryScreen.message_signal
  • LongMemoryScreen
    • LongMemoryScreen.compose_content()
    • LongMemoryScreen.on_memory_table_widget_memory_selected()
    • LongMemoryScreen.refresh_data()
    • LongMemoryScreen.can_focus
    • LongMemoryScreen.can_focus_children
    • LongMemoryScreen.screen_layout_refresh_signal
    • LongMemoryScreen.bindings_updated_signal
    • LongMemoryScreen.text_selection_started_signal
    • LongMemoryScreen.highlight_style
    • LongMemoryScreen.absolute_offset
    • LongMemoryScreen.styles
    • LongMemoryScreen.message_signal
  • MemoryLogsScreen
    • MemoryLogsScreen.compose_content()
    • MemoryLogsScreen.on_memory_table_widget_memory_selected()
    • MemoryLogsScreen.refresh_data()
    • MemoryLogsScreen.can_focus
    • MemoryLogsScreen.can_focus_children
    • MemoryLogsScreen.screen_layout_refresh_signal
    • MemoryLogsScreen.bindings_updated_signal
    • MemoryLogsScreen.text_selection_started_signal
    • MemoryLogsScreen.highlight_style
    • MemoryLogsScreen.absolute_offset
    • MemoryLogsScreen.styles
    • MemoryLogsScreen.message_signal
  • HealthScreen
    • HealthScreen.compose_content()
    • HealthScreen.refresh_data()
    • HealthScreen.can_focus
    • HealthScreen.can_focus_children
    • HealthScreen.screen_layout_refresh_signal
    • HealthScreen.bindings_updated_signal
    • HealthScreen.text_selection_started_signal
    • HealthScreen.highlight_style
    • HealthScreen.absolute_offset
    • HealthScreen.styles
    • HealthScreen.message_signal
• orka.tui.textual_widgets module
  • StatsWidget
    • StatsWidget.update_stats()
    • StatsWidget.can_focus
    • StatsWidget.can_focus_children
    • StatsWidget.highlight_style
    • StatsWidget.absolute_offset
    • StatsWidget.styles
    • StatsWidget.message_signal
  • MemoryTableWidget
    • MemoryTableWidget.MemorySelected
      • MemoryTableWidget.MemorySelected.memory_data
      • MemoryTableWidget.MemorySelected.time
      • MemoryTableWidget.MemorySelected.bubble
      • MemoryTableWidget.MemorySelected.handler_name
      • MemoryTableWidget.MemorySelected.no_dispatch
      • MemoryTableWidget.MemorySelected.verbose
    • MemoryTableWidget.current_memories
    • MemoryTableWidget.selected_memory_key
    • MemoryTableWidget.on_data_table_cell_selected()
    • MemoryTableWidget.on_data_table_row_selected()
    • MemoryTableWidget.update_data()
    • MemoryTableWidget.can_focus
    • MemoryTableWidget.can_focus_children
    • MemoryTableWidget.columns
    • MemoryTableWidget.rows
    • MemoryTableWidget.highlight_style
    • MemoryTableWidget.absolute_offset
    • MemoryTableWidget.styles
    • MemoryTableWidget.message_signal
  • HealthWidget
    • HealthWidget.compose()
    • HealthWidget.update_health()
    • HealthWidget.can_focus
    • HealthWidget.can_focus_children
    • HealthWidget.highlight_style
    • HealthWidget.absolute_offset
    • HealthWidget.styles
    • HealthWidget.message_signal
  • LogsWidget
    • LogsWidget.update_data()
    • LogsWidget.can_focus
    • LogsWidget.can_focus_children
    • LogsWidget.columns
    • LogsWidget.rows
    • LogsWidget.highlight_style
    • LogsWidget.absolute_offset
    • LogsWidget.styles
    • LogsWidget.message_signal