Skip to content

software-mansion/live-debugger

Repository files navigation

LiveDebugger

LiveDebugger is a browser-based tool for debugging LiveView applications. It provides insights into your LiveViews, their LiveComponents, events, state transitions, and more. output

Installation

Add live_debugger to your list of dependencies in mix.exs:

  defp deps do
    [
      {:live_debugger,
       git: "https://github.com/software-mansion-labs/live-debugger.git",
       tag: "v0.1.0-rc.1",
       only: :dev}
    ]
  end

After you start your application LiveDebugger will be running at a default port http://localhost:4007.

Browser features

List of browser features:

  • Debug button
  • Components highlighting (coming soon!)

Some features require injecting JS into the debugged application. To achieve that you need to turn them on in the config and add LiveDebugger scripts to your application root layout.

# config/dev.exs

config :live_debugger, browser_features?: true
# lib/my_app_web/components/layouts/root.html.heex

<head>
  <%= if Application.get_env(:live_debugger, :browser_features?) do %>
    <script id="live-debugger-scripts" src={Application.get_env(:live_debugger, :assets_url)}>
    </script>
  <% end %>
</head>

Optional configuration

# config/dev.exs

config :live_debugger,
  ip: {127, 0, 0, 1}, # IP on which LiveDebugger will be hosted
  port: 4007, # Port on which LiveDebugger will be hosted
  secret_key_base: <SECRET_KEY_BASE>, # Secret key used for LiveDebugger.Endpoint
  signing_salt: "your_signing_salt", # Signing salt used for LiveDebugger.Endpoint
  adapter: Bandit.PhoenixAdapter # Adapter used in LiveDebugger.Endpoint

Contributing

For those planning to contribute to this project, you can run a dev version of the debugger with the following commands:

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

mix assets.build

Authors

LiveDebugger is created by Software Mansion.

Since 2012 Software Mansion 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.

Copyright 2025, Software Mansion

Software Mansion

Licensed under the Apache License, Version 2.0