# CLI TUI input and output functions # Handles all input and output to the console # CLI Settings are handled separately in cli_settings.py import asyncio import sys import threading import time from typing import Generator from prompt_toolkit import PromptSession, print_formatted_text from prompt_toolkit.application import Application from prompt_toolkit.completion import CompleteEvent, Completer, Completion from prompt_toolkit.document import Document from prompt_toolkit.formatted_text import HTML, FormattedText, StyleAndTextTuples from prompt_toolkit.input import create_input from prompt_toolkit.key_binding import KeyBindings from prompt_toolkit.key_binding.key_processor import KeyPressEvent from prompt_toolkit.keys import Keys from prompt_toolkit.layout.containers import HSplit, Window from prompt_toolkit.layout.controls import FormattedTextControl from prompt_toolkit.layout.layout import Layout from prompt_toolkit.lexers import Lexer from prompt_toolkit.patch_stdout import patch_stdout from prompt_toolkit.shortcuts import print_container from prompt_toolkit.styles import Style from prompt_toolkit.widgets import Frame, TextArea from openhands import __version__ from openhands.core.config import OpenHandsConfig from openhands.core.schema import AgentState from openhands.events import EventSource, EventStream from openhands.events.action import ( Action, ActionConfirmationStatus, ChangeAgentStateAction, CmdRunAction, MessageAction, ) from openhands.events.event import Event from openhands.events.observation import ( AgentStateChangedObservation, CmdOutputObservation, ErrorObservation, FileEditObservation, FileReadObservation, ) from openhands.llm.metrics import Metrics ENABLE_STREAMING = False # FIXME: this doesn't work # Global TextArea for streaming output streaming_output_text_area: TextArea | None = None # Color and styling constants COLOR_GOLD = '#FFD700' COLOR_GREY = '#808080' DEFAULT_STYLE = Style.from_dict( { 'gold': COLOR_GOLD, 'grey': COLOR_GREY, 'prompt': f'{COLOR_GOLD} bold', } ) COMMANDS = { '/exit': 'Exit the application', '/help': 'Display available commands', '/init': 'Initialize a new repository', '/status': 'Display conversation details and usage metrics', '/new': 'Create a new conversation', '/settings': 'Display and modify current settings', '/resume': 'Resume the agent when paused', } print_lock = threading.Lock() class UsageMetrics: def __init__(self) -> None: self.metrics: Metrics = Metrics() self.session_init_time: float = time.time() class CustomDiffLexer(Lexer): """Custom lexer for the specific diff format.""" def lex_document(self, document: Document) -> StyleAndTextTuples: lines = document.lines def get_line(lineno: int) -> StyleAndTextTuples: line = lines[lineno] if line.startswith('+'): return [('ansigreen', line)] elif line.startswith('-'): return [('ansired', line)] elif line.startswith('[') or line.startswith('('): # Style for metadata lines like [Existing file...] or (content...) return [('bold', line)] else: # Default style for other lines return [('', line)] return get_line # CLI initialization and startup display functions def display_runtime_initialization_message(runtime: str) -> None: print_formatted_text('') if runtime == 'local': print_formatted_text(HTML('⚙️ Starting local runtime...')) elif runtime == 'docker': print_formatted_text(HTML('🐳 Starting Docker runtime...')) print_formatted_text('') def display_initialization_animation(text: str, is_loaded: asyncio.Event) -> None: ANIMATION_FRAMES = ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏'] i = 0 while not is_loaded.is_set(): sys.stdout.write('\n') sys.stdout.write( f'\033[s\033[J\033[38;2;255;215;0m[{ANIMATION_FRAMES[i % len(ANIMATION_FRAMES)]}] {text}\033[0m\033[u\033[1A' ) sys.stdout.flush() time.sleep(0.1) i += 1 sys.stdout.write('\r' + ' ' * (len(text) + 10) + '\r') sys.stdout.flush() def display_banner(session_id: str) -> None: print_formatted_text( HTML(r""" ___ _ _ _ / _ \ _ __ ___ _ __ | | | | __ _ _ __ __| |___ | | | | '_ \ / _ \ '_ \| |_| |/ _` | '_ \ / _` / __| | |_| | |_) | __/ | | | _ | (_| | | | | (_| \__ \ \___ /| .__/ \___|_| |_|_| |_|\__,_|_| |_|\__,_|___/ |_| """), style=DEFAULT_STYLE, ) print_formatted_text(HTML(f'OpenHands CLI v{__version__}')) print_formatted_text('') print_formatted_text(HTML(f'Initialized conversation {session_id}')) print_formatted_text('') def display_welcome_message(message: str = '') -> None: print_formatted_text( HTML("Let's start building!\n"), style=DEFAULT_STYLE ) if message: print_formatted_text( HTML(f'{message} Type /help for help'), style=DEFAULT_STYLE, ) else: print_formatted_text( HTML('What do you want to build? Type /help for help'), style=DEFAULT_STYLE, ) def display_initial_user_prompt(prompt: str) -> None: print_formatted_text( FormattedText( [ ('', '\n'), (COLOR_GOLD, '> '), ('', prompt), ] ) ) # Prompt output display functions def display_event(event: Event, config: OpenHandsConfig) -> None: global streaming_output_text_area with print_lock: if isinstance(event, Action): if hasattr(event, 'thought'): display_message(event.thought) if hasattr(event, 'final_thought'): display_message(event.final_thought) if isinstance(event, MessageAction): if event.source == EventSource.AGENT: display_message(event.content) if isinstance(event, CmdRunAction): display_command(event) if event.confirmation_state == ActionConfirmationStatus.CONFIRMED: initialize_streaming_output() if isinstance(event, CmdOutputObservation): display_command_output(event.content) if isinstance(event, FileEditObservation): display_file_edit(event) if isinstance(event, FileReadObservation): display_file_read(event) if isinstance(event, AgentStateChangedObservation): display_agent_state_change_message(event.agent_state) if isinstance(event, ErrorObservation): display_error(event.content) def display_message(message: str) -> None: message = message.strip() if message: print_formatted_text(f'\n{message}') def display_error(error: str) -> None: error = error.strip() if error: container = Frame( TextArea( text=error, read_only=True, style='ansired', wrap_lines=True, ), title='Error', style='ansired', ) print_formatted_text('') print_container(container) def display_command(event: CmdRunAction) -> None: container = Frame( TextArea( text=f'$ {event.command}', read_only=True, style=COLOR_GREY, wrap_lines=True, ), title='Command', style='ansiblue', ) print_formatted_text('') print_container(container) def display_command_output(output: str) -> None: lines = output.split('\n') formatted_lines = [] for line in lines: if line.startswith('[Python Interpreter') or line.startswith('openhands@'): # TODO: clean this up once we clean up terminal output continue formatted_lines.append(line) formatted_lines.append('\n') # Remove the last newline if it exists if formatted_lines: formatted_lines.pop() container = Frame( TextArea( text=''.join(formatted_lines), read_only=True, style=COLOR_GREY, wrap_lines=True, ), title='Command Output', style=f'fg:{COLOR_GREY}', ) print_formatted_text('') print_container(container) def display_file_edit(event: FileEditObservation) -> None: container = Frame( TextArea( text=event.visualize_diff(n_context_lines=4), read_only=True, wrap_lines=True, lexer=CustomDiffLexer(), ), title='File Edit', style=f'fg:{COLOR_GREY}', ) print_formatted_text('') print_container(container) def display_file_read(event: FileReadObservation) -> None: content = event.content.replace('\t', ' ') container = Frame( TextArea( text=content, read_only=True, style=COLOR_GREY, wrap_lines=True, ), title='File Read', style=f'fg:{COLOR_GREY}', ) print_formatted_text('') print_container(container) def initialize_streaming_output(): """Initialize the streaming output TextArea.""" if not ENABLE_STREAMING: return global streaming_output_text_area streaming_output_text_area = TextArea( text='', read_only=True, style=COLOR_GREY, wrap_lines=True, ) container = Frame( streaming_output_text_area, title='Streaming Output', style=f'fg:{COLOR_GREY}', ) print_formatted_text('') print_container(container) def update_streaming_output(text: str): """Update the streaming output TextArea with new text.""" global streaming_output_text_area # Append the new text to the existing content if streaming_output_text_area is not None: current_text = streaming_output_text_area.text streaming_output_text_area.text = current_text + text # Interactive command output display functions def display_help() -> None: # Version header and introduction print_formatted_text( HTML( f'\nOpenHands CLI v{__version__}\n' 'OpenHands CLI lets you interact with the OpenHands agent from the command line.\n' ) ) # Usage examples print_formatted_text('Things that you can try:') print_formatted_text( HTML( '• Ask questions about the codebase > How does main.py work?\n' '• Edit files or add new features > Add a new function to ...\n' '• Find and fix issues > Fix the type error in ...\n' ) ) # Tips section print_formatted_text( 'Some tips to get the most out of OpenHands:\n' '• Be as specific as possible about the desired outcome or the problem to be solved.\n' '• Provide context, including relevant file paths and line numbers if available.\n' '• Break large tasks into smaller, manageable prompts.\n' '• Include relevant error messages or logs.\n' '• Specify the programming language or framework, if not obvious.\n' ) # Commands section print_formatted_text(HTML('Interactive commands:')) commands_html = '' for command, description in COMMANDS.items(): commands_html += f'{command} - {description}\n' print_formatted_text(HTML(commands_html)) # Footer print_formatted_text( HTML( 'Learn more at: https://docs.all-hands.dev/usage/getting-started' ) ) def display_usage_metrics(usage_metrics: UsageMetrics) -> None: cost_str = f'${usage_metrics.metrics.accumulated_cost:.6f}' input_tokens_str = ( f'{usage_metrics.metrics.accumulated_token_usage.prompt_tokens:,}' ) cache_read_str = ( f'{usage_metrics.metrics.accumulated_token_usage.cache_read_tokens:,}' ) cache_write_str = ( f'{usage_metrics.metrics.accumulated_token_usage.cache_write_tokens:,}' ) output_tokens_str = ( f'{usage_metrics.metrics.accumulated_token_usage.completion_tokens:,}' ) total_tokens_str = f'{usage_metrics.metrics.accumulated_token_usage.prompt_tokens + usage_metrics.metrics.accumulated_token_usage.completion_tokens:,}' labels_and_values = [ (' Total Cost (USD):', cost_str), ('', ''), (' Total Input Tokens:', input_tokens_str), (' Cache Hits:', cache_read_str), (' Cache Writes:', cache_write_str), (' Total Output Tokens:', output_tokens_str), ('', ''), (' Total Tokens:', total_tokens_str), ] # Calculate max widths for alignment max_label_width = max(len(label) for label, _ in labels_and_values) max_value_width = max(len(value) for _, value in labels_and_values) # Construct the summary text with aligned columns summary_lines = [ f'{label:<{max_label_width}} {value:<{max_value_width}}' for label, value in labels_and_values ] summary_text = '\n'.join(summary_lines) container = Frame( TextArea( text=summary_text, read_only=True, style=COLOR_GREY, wrap_lines=True, ), title='Usage Metrics', style=f'fg:{COLOR_GREY}', ) print_container(container) def get_session_duration(session_init_time: float) -> str: current_time = time.time() session_duration = current_time - session_init_time hours, remainder = divmod(session_duration, 3600) minutes, seconds = divmod(remainder, 60) return f'{int(hours)}h {int(minutes)}m {int(seconds)}s' def display_shutdown_message(usage_metrics: UsageMetrics, session_id: str) -> None: duration_str = get_session_duration(usage_metrics.session_init_time) print_formatted_text(HTML('Closing current conversation...')) print_formatted_text('') display_usage_metrics(usage_metrics) print_formatted_text('') print_formatted_text(HTML(f'Conversation duration: {duration_str}')) print_formatted_text('') print_formatted_text(HTML(f'Closed conversation {session_id}')) print_formatted_text('') def display_status(usage_metrics: UsageMetrics, session_id: str) -> None: duration_str = get_session_duration(usage_metrics.session_init_time) print_formatted_text('') print_formatted_text(HTML(f'Conversation ID: {session_id}')) print_formatted_text(HTML(f'Uptime: {duration_str}')) print_formatted_text('') display_usage_metrics(usage_metrics) def display_agent_running_message() -> None: print_formatted_text('') print_formatted_text( HTML('Agent running... (Press Ctrl-P to pause)') ) def display_agent_state_change_message(agent_state: str) -> None: if agent_state == AgentState.PAUSED: print_formatted_text('') print_formatted_text( HTML( 'Agent paused... (Enter /resume to continue)' ) ) elif agent_state == AgentState.FINISHED: print_formatted_text('') print_formatted_text(HTML('Task completed...')) elif agent_state == AgentState.AWAITING_USER_INPUT: print_formatted_text('') print_formatted_text(HTML('Agent is waiting for your input...')) # Common input functions class CommandCompleter(Completer): """Custom completer for commands.""" def __init__(self, agent_state: str) -> None: super().__init__() self.agent_state = agent_state def get_completions( self, document: Document, complete_event: CompleteEvent ) -> Generator[Completion, None, None]: text = document.text_before_cursor.lstrip() if text.startswith('/'): available_commands = dict(COMMANDS) if self.agent_state != AgentState.PAUSED: available_commands.pop('/resume', None) for command, description in available_commands.items(): if command.startswith(text): yield Completion( command, start_position=-len(text), display_meta=description, style='bg:ansidarkgray fg:gold', ) def create_prompt_session() -> PromptSession[str]: return PromptSession(style=DEFAULT_STYLE) async def read_prompt_input(agent_state: str, multiline: bool = False) -> str: try: prompt_session = create_prompt_session() prompt_session.completer = ( CommandCompleter(agent_state) if not multiline else None ) if multiline: kb = KeyBindings() @kb.add('c-d') def _(event: KeyPressEvent) -> None: event.current_buffer.validate_and_handle() with patch_stdout(): print_formatted_text('') message = await prompt_session.prompt_async( HTML( 'Enter your message and press Ctrl-D to finish:\n' ), multiline=True, key_bindings=kb, ) else: with patch_stdout(): print_formatted_text('') message = await prompt_session.prompt_async( HTML('> '), ) return message if message is not None else '' except (KeyboardInterrupt, EOFError): return '/exit' async def read_confirmation_input() -> str: try: prompt_session = create_prompt_session() with patch_stdout(): print_formatted_text('') confirmation: str = await prompt_session.prompt_async( HTML('Proceed with action? (y)es/(n)o/(a)lways > '), ) confirmation = '' if confirmation is None else confirmation.strip().lower() if confirmation in ['y', 'yes']: return 'yes' elif confirmation in ['n', 'no']: return 'no' elif confirmation in ['a', 'always']: return 'always' else: return 'no' except (KeyboardInterrupt, EOFError): return 'no' async def process_agent_pause(done: asyncio.Event, event_stream: EventStream) -> None: input = create_input() def keys_ready() -> None: for key_press in input.read_keys(): if ( key_press.key == Keys.ControlP or key_press.key == Keys.ControlC or key_press.key == Keys.ControlD ): print_formatted_text('') print_formatted_text(HTML('Pausing the agent...')) event_stream.add_event( ChangeAgentStateAction(AgentState.PAUSED), EventSource.USER, ) done.set() with input.raw_mode(): with input.attach(keys_ready): await done.wait() def cli_confirm( question: str = 'Are you sure?', choices: list[str] | None = None ) -> int: """Display a confirmation prompt with the given question and choices. Returns the index of the selected choice. """ if choices is None: choices = ['Yes', 'No'] selected = [0] # Using list to allow modification in closure def get_choice_text() -> list: return [ ('class:question', f'{question}\n\n'), ] + [ ( 'class:selected' if i == selected[0] else 'class:unselected', f'{"> " if i == selected[0] else " "}{choice}\n', ) for i, choice in enumerate(choices) ] kb = KeyBindings() @kb.add('up') def _(event: KeyPressEvent) -> None: selected[0] = (selected[0] - 1) % len(choices) @kb.add('down') def _(event: KeyPressEvent) -> None: selected[0] = (selected[0] + 1) % len(choices) @kb.add('enter') def _(event: KeyPressEvent) -> None: event.app.exit(result=selected[0]) style = Style.from_dict({'selected': COLOR_GOLD, 'unselected': ''}) layout = Layout( HSplit( [ Window( FormattedTextControl(get_choice_text), always_hide_cursor=True, ) ] ) ) app = Application( layout=layout, key_bindings=kb, style=style, mouse_support=True, full_screen=False, ) return app.run(in_thread=True) def kb_cancel() -> KeyBindings: """Custom key bindings to handle ESC as a user cancellation.""" bindings = KeyBindings() @bindings.add('escape') def _(event: KeyPressEvent) -> None: event.app.exit(exception=UserCancelledError, style='class:aborting') return bindings class UserCancelledError(Exception): """Raised when the user cancels an operation via key binding.""" pass