https://github.com/software-mansion/live-debugger
Tool for debugging LiveView applications.
https://github.com/software-mansion/live-debugger
debugger debugging dev-tools developer-tools elixir phoenix-framework phoenix-liveview
Last synced: 6 months ago
JSON representation
Tool for debugging LiveView applications.
- Host: GitHub
- URL: https://github.com/software-mansion/live-debugger
- Owner: software-mansion
- License: apache-2.0
- Created: 2024-12-04T10:23:16.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-07T07:43:19.000Z (12 months ago)
- Last Synced: 2025-04-07T08:31:58.305Z (12 months ago)
- Topics: debugger, debugging, dev-tools, developer-tools, elixir, phoenix-framework, phoenix-liveview
- Language: Elixir
- Homepage: https://hex.pm/packages/live_debugger
- Size: 2.25 MB
- Stars: 381
- Watchers: 4
- Forks: 9
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-swm-tools - Live Debugger - A browser-based tool for **debugging applications written in Phoenix LiveView** (an Elixir library), allowing developers to inspect component trees and trace callbacks. (Products and libraries)
README
[](https://hexdocs.pm/live_debugger)
[](https://hex.pm/packages/live_debugger)
[](https://github.com/software-mansion/live-debugger/blob/main/LICENSE)
LiveDebugger is a browser-based tool for debugging applications written in [Phoenix LiveView](https://github.com/phoenixframework/phoenix_live_view) - an Elixir library designed for building rich, interactive online experiences with server-rendered HTML.
Designed to enhance your development experience LiveDebugger gives you:
- :deciduous_tree: A detailed view of your LiveComponents tree
- :mag: The ability to inspect assigns for LiveViews and LiveComponents
- :link: Tracing and filtering of their callback executions
- :flashlight: Highlighting components in debugged apps
- :telescope: Inspecting elements on the page
https://github.com/user-attachments/assets/a09d440c-4217-4597-b30e-f8b911a9094a
## Getting started
> [!IMPORTANT]
> LiveDebugger should not be used on production - make sure that the dependency you've added is `:dev` only
### Mix installation
Add `live_debugger` to your list of dependencies in `mix.exs`:
```elixir
defp deps do
[
{:live_debugger, "~> 0.4.0", only: :dev}
]
end
```
For full experience we recommend adding below line to your application root layout. It attaches `meta` tag and LiveDebugger scripts in dev environment enabling browser features.
```elixir
# lib/my_app_web/components/layouts/root.html.heex
<%= Application.get_env(:live_debugger, :live_debugger_tags) %>
```
After you start your application, LiveDebugger will be running at a default port `http://localhost:4007`.
### Igniter installation
LiveDebugger has [Igniter](https://github.com/ash-project/igniter) support - an alternative for standard mix installation. It'll automatically add LiveDebugger dependency and modify your `root.html.heex` after you use the below command.
```bash
mix igniter.install live_debugger
```
### DevTools extension
Since version v0.2.0 you can install official LiveDebugger DevTools extension, giving you the ability to interact with its features alongside your application's runtime.
- [Chrome extension](https://chromewebstore.google.com/detail/gmdfnfcigbfkmghbjeelmbkbiglbmbpe)
- [Firefox extension](https://addons.mozilla.org/en-US/firefox/addon/livedebugger-devtools/)
> [!NOTE]
> Ensure the main LiveDebugger dependency is added to your mix project, as the browser plugin alone is not enough.
## Optional configuration
See [Configuration Guide](https://hexdocs.pm/live_debugger/config.html) for details on how to customize LiveDebugger to your needs.
## Contributing
For those planning to contribute to this project, you can run a dev version of the debugger with the following commands:
```console
mix setup
iex -S mix
```
It'll run the application declared in the `dev/` directory with the library installed.
LiveReload is working both for `.ex` files and static files, but if some styles don't show up, try using this command
```console
mix assets.build:dev
```
## What's next
To learn about our upcoming plans and developments, please visit our [discussion page](https://github.com/software-mansion/live-debugger/discussions/355).
## Authors
LiveDebugger is created by Software Mansion.
Since 2012 [Software Mansion](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=livedebugger) is a software agency with experience in building web and mobile apps as well as complex multimedia solutions. We are Core React Native Contributors, Elixir ecosystem experts, and live streaming and broadcasting technologies specialists. We can help you build your next dream product – [Hire us](https://swmansion.com/contact/projects).
Copyright 2025, [Software Mansion](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=livedebugger)
[](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=livedebugger)
Licensed under the [Apache License, Version 2.0](LICENSE)