Skip to content

Document debug setup #421

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

Open
samdark wants to merge 3 commits into
base: master
Choose a base branch
from
+23 −0
Open

Document debug setup #421

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7390ff7
Document debug setup
samdark May 5, 2026
fa00142
Clarify debugger status
samdark May 5, 2026
e3c4a81
Merge branch 'master' into 323-debug-config
vjik May 7, 2026
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
23 changes: 23 additions & 0 deletions src/guide/start/workflow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,29 @@ In addition to the web application, you can access a console script via `./yii`
Use this script to run background and maintenance tasks for the application, which the
[Console Application Section](../tutorial/console-applications.md) describes.

## Experimental debugger <span id="debugging"></span>

Yii has a debugger that can collect debug data for web requests and expose it through the
[Yii Dev Panel](https://yiisoft.github.io/yii-dev-panel/). The debugger is a work in progress. It isn't released as a
stable package, and its API, routes, and setup may change or be deprecated.

To try the current development version, install the debug API package:

```shell
composer require yiisoft/yii-debug-api:^3.0@dev
```

Enable debug mode in `.env`:

```dotenv
APP_DEBUG=true
```

The package registers its routes automatically. Start the application and open `/debug` to check that the debug API is
available. Then open [Yii Dev Panel](https://yiisoft.github.io/yii-dev-panel/) and set your application URL there.

> [!CAUTION]
> Use debug mode for local development. In production, keep `APP_DEBUG=false` and don't expose debug routes publicly.

## Application structure <span id="application-structure"></span>

Expand Down
Loading