Skip to content

docs: update --debug references to --scenario-debug (#618) #765

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
drewdrewthis merged 1 commit into from
Jul 16, 2026
+5 −5
Merged

docs: update --debug references to --scenario-debug (#618) #765

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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
Expand Down
6 changes: 3 additions & 3 deletions docs/docs/pages/basics/debug-mode.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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?
Expand Down
Loading