Add /cp command to CLI to copy last response to clipboard (#2386)

Author: 07pepa

clai/README.md

@@ -49,6 +49,7 @@ Either way, running `clai` will start an interactive session where you can chat
 - `/exit`: Exit the session
 - `/markdown`: Show the last response in markdown format
 - `/multiline`: Toggle multiline input mode (use Ctrl+D to submit)
+- `/cp`: Copy the last response to clipboard
 
 ## Help
 
@@ -61,6 +62,7 @@ Special prompts:
 * `/exit` - exit the interactive mode (ctrl-c and ctrl-d also work)
 * `/markdown` - show the last markdown output of the last question
 * `/multiline` - toggle multiline mode
+* `/cp` - copy the last response to clipboard
 
 positional arguments:
   prompt                AI Prompt, if omitted fall into interactive mode

docs/cli.md

@@ -46,6 +46,7 @@ Either way, running `clai` will start an interactive session where you can chat
 - `/exit`: Exit the session
 - `/markdown`: Show the last response in markdown format
 - `/multiline`: Toggle multiline input mode (use Ctrl+D to submit)
+- `/cp`: Copy the last response to clipboard
 
 ### Help
 

pydantic_ai_slim/pydantic_ai/_cli.py

@@ -18,12 +18,13 @@
 from ._run_context import AgentDepsT
 from .agent import AbstractAgent, Agent
 from .exceptions import UserError
-from .messages import ModelMessage
+from .messages import ModelMessage, TextPart
 from .models import KnownModelName, infer_model
 from .output import OutputDataT
 
 try:
     import argcomplete
+    import pyperclip
     from prompt_toolkit import PromptSession
     from prompt_toolkit.auto_suggest import AutoSuggestFromHistory, Suggestion
     from prompt_toolkit.buffer import Buffer
@@ -38,7 +39,7 @@
     from rich.text import Text
 except ImportError as _import_error:
     raise ImportError(
-        'Please install `rich`, `prompt-toolkit` and `argcomplete` to use the Pydantic AI CLI, '
+        'Please install `rich`, `prompt-toolkit`, `pyperclip` and `argcomplete` to use the Pydantic AI CLI, '
         'you can use the `cli` optional group — `pip install "pydantic-ai-slim[cli]"`'
     ) from _import_error
 
@@ -114,6 +115,7 @@ def cli(  # noqa: C901
 * `/exit` - exit the interactive mode (ctrl-c and ctrl-d also work)
 * `/markdown` - show the last markdown output of the last question
 * `/multiline` - toggle multiline mode
+* `/cp` - copy the last response to clipboard
 """,
         formatter_class=argparse.RawTextHelpFormatter,
     )
@@ -237,7 +239,7 @@ async def run_chat(
 
     while True:
         try:
-            auto_suggest = CustomAutoSuggest(['/markdown', '/multiline', '/exit'])
+            auto_suggest = CustomAutoSuggest(['/markdown', '/multiline', '/exit', '/cp'])
             text = await session.prompt_async(f'{prog_name} ➤ ', auto_suggest=auto_suggest, multiline=multiline)
         except (KeyboardInterrupt, EOFError):  # pragma: no cover
             return 0
@@ -347,6 +349,19 @@ def handle_slash_command(
     elif ident_prompt == '/exit':
         console.print('[dim]Exiting…[/dim]')
         return 0, multiline
+    elif ident_prompt == '/cp':
+        try:
+            parts = messages[-1].parts
+        except IndexError:
+            console.print('[dim]No output available to copy.[/dim]')
+        else:
+            text_to_copy = '\n\n'.join(part.content for part in parts if isinstance(part, TextPart))
+            text_to_copy = text_to_copy.strip()
+            if text_to_copy:
+                pyperclip.copy(text_to_copy)
+                console.print('[dim]Copied last output to clipboard.[/dim]')
+            else:
+                console.print('[dim]No text content to copy.[/dim]')
     else:
         console.print(f'[red]Unknown command[/red] [magenta]`{ident_prompt}`[/magenta]')
     return None, multiline

pydantic_ai_slim/pyproject.toml

@@ -82,7 +82,7 @@ huggingface = ["huggingface-hub[inference]>=0.33.5"]
 duckduckgo = ["ddgs>=9.0.0"]
 tavily = ["tavily-python>=0.5.0"]
 # CLI
-cli = ["rich>=13", "prompt-toolkit>=3", "argcomplete>=3.5.0"]
+cli = ["rich>=13", "prompt-toolkit>=3", "argcomplete>=3.5.0", "pyperclip>=1.9.0"]
 # MCP
 mcp = ["mcp>=1.10.0; python_version >= '3.10'"]
 # Evals

tests/test_cli.py

@@ -165,10 +165,17 @@ def test_cli_prompt(capfd: CaptureFixture[str], env: TestEnv):
 
 def test_chat(capfd: CaptureFixture[str], mocker: MockerFixture, env: TestEnv):
     env.set('OPENAI_API_KEY', 'test')
+
+    # mocking is needed because of ci does not have xclip or xselect installed
+    def mock_copy(text: str) -> None:
+        pass
+
+    mocker.patch('pyperclip.copy', mock_copy)
     with create_pipe_input() as inp:
         inp.send_text('\n')
         inp.send_text('hello\n')
         inp.send_text('/markdown\n')
+        inp.send_text('/cp\n')
         inp.send_text('/exit\n')
         session = PromptSession[Any](input=inp, output=DummyOutput())
         m = mocker.patch('pydantic_ai._cli.PromptSession', return_value=session)
@@ -182,6 +189,7 @@ def test_chat(capfd: CaptureFixture[str], mocker: MockerFixture, env: TestEnv):
                 IsStr(regex='goodbye *Markdown output of last question:'),
                 '',
                 'goodbye',
+                'Copied last output to clipboard.',
                 'Exiting…',
             ]
         )
@@ -212,6 +220,33 @@ def test_handle_slash_command_multiline():
     assert io.getvalue() == snapshot('Disabling multiline mode.\n')
 
 
+def test_handle_slash_command_copy(mocker: MockerFixture):
+    io = StringIO()
+    # mocking is needed because of ci does not have xclip or xselect installed
+    mock_clipboard: list[str] = []
+
+    def append_to_clipboard(text: str) -> None:
+        mock_clipboard.append(text)
+
+    mocker.patch('pyperclip.copy', append_to_clipboard)
+    assert handle_slash_command('/cp', [], False, Console(file=io), 'default') == (None, False)
+    assert io.getvalue() == snapshot('No output available to copy.\n')
+    assert len(mock_clipboard) == 0
+
+    messages: list[ModelMessage] = [ModelResponse(parts=[TextPart(''), ToolCallPart('foo', '{}')])]
+    io = StringIO()
+    assert handle_slash_command('/cp', messages, True, Console(file=io), 'default') == (None, True)
+    assert io.getvalue() == snapshot('No text content to copy.\n')
+    assert len(mock_clipboard) == 0
+
+    messages: list[ModelMessage] = [ModelResponse(parts=[TextPart('hello'), ToolCallPart('foo', '{}')])]
+    io = StringIO()
+    assert handle_slash_command('/cp', messages, True, Console(file=io), 'default') == (None, True)
+    assert io.getvalue() == snapshot('Copied last output to clipboard.\n')
+    assert len(mock_clipboard) == 1
+    assert mock_clipboard[0] == snapshot('hello')
+
+
 def test_handle_slash_command_exit():
     io = StringIO()
     assert handle_slash_command('/exit', [], False, Console(file=io), 'default') == (0, False)