Skip to content
Github

Local Debugging of your Frames

The frames.js debugger comes inside the frames.js starter repos and will run automatically when you run your code. By default it runs on port 3010, at http://localhost:3010.

Features

  • fully interactive frames
  • multi step actions support
  • connect wallet + transactions
  • performance analysis
  • frame validations
  • jump between Frames
  • inspect state
  • mock hub states
  • impersonate a user, or login with a real farcaster signer
  • test Open Frames with an XMTP signer

Local Installation

You can install and run the frames.js debugger independently of your frame, including for frames that don't use frames.js.

$ npm install -g @frames.js/debugger

The debugger can then be launched from the command line with the frames command.

$ frames

Hosted Debugger

We've provided a hosted version of the debugger for convenience. Note it won't work with localhost urls without a tunneling service like ngrok, which is why we recommend running a local debugger.