diff --git a/README.md b/README.md index bf4627661..dce3597a8 100644 --- a/README.md +++ b/README.md @@ -421,7 +421,7 @@ LANGWATCH_API_KEY="your-api-key" ## Debug mode -You can enable debug mode by setting the `debug` field to `True` in the `Scenario.configure` method or in the specific scenario you are running, or by passing the `--debug` flag to pytest. +You can enable debug mode by setting the `debug` field to `True` in the `Scenario.configure` method or in the specific scenario you are running, or by passing the `--scenario-debug` flag to pytest. Debug mode allows you to see the messages in slow motion step by step, and intervene with your own inputs to debug your agent from the middle of the conversation. @@ -432,7 +432,7 @@ scenario.configure(default_model="openai/gpt-4.1-mini", debug=True) or ```bash -pytest -s tests/test_vegetarian_recipe_agent.py --debug +pytest -s tests/test_vegetarian_recipe_agent.py --scenario-debug ``` ## Cache diff --git a/docs/docs/pages/basics/debug-mode.mdx b/docs/docs/pages/basics/debug-mode.mdx index d062a7bdd..47683f831 100644 --- a/docs/docs/pages/basics/debug-mode.mdx +++ b/docs/docs/pages/basics/debug-mode.mdx @@ -68,10 +68,10 @@ Enable debug mode from the command line: ```bash # Enable debug mode for all tests -pytest tests/ --debug -s +pytest tests/ --scenario-debug -s # Run specific test with debug mode -pytest tests/test_my_agent.py::test_specific_scenario --debug -s +pytest tests/test_my_agent.py::test_specific_scenario --scenario-debug -s ``` :::tip @@ -99,7 +99,7 @@ You have two options: Here's what a debug session looks like: ```bash -$ pytest tests/test_weather_agent.py --debug -s +$ pytest tests/test_weather_agent.py --scenario-debug -s [Scenario: weather query] [Debug Mode] Press enter to continue or type a message to send [Scenario: weather query] User: What's the weather like today?