main
md 35 lines 2.33 KB
Rendered Raw
1 # @ipshipyard/libp2p-inspector
2
3 [![codecov](https://img.shields.io/codecov/c/github/ipshipyard/js-libp2p-inspector.svg?style=flat-square)](https://codecov.io/gh/ipshipyard/js-libp2p-inspector)
4 [![CI](https://img.shields.io/github/actions/workflow/status/ipshipyard/js-libp2p-inspector/js-test-and-release.yml?branch=main\&style=flat-square)](https://github.com/ipshipyard/js-libp2p-inspector/actions/workflows/js-test-and-release.yml?query=branch%3Amain)
5
6 > Inspect a running libp2p node
7
8 A web based inspector for libp2p nodes that runs in [browser devtools](https://github.com/ipshipyard/js-libp2p-inspector/tree/main/packages/libp2p-devtools) or as a
9 standalone [Electron app](https://github.com/ipshipyard/js-libp2p-inspector/tree/main/packages/libp2p-inspector).
10
11 ![libp2p-inspector running in Electron](https://github.com/ipshipyard/js-libp2p-inspector/blob/main/assets/electron.png?raw=true)
12
13 More in the [blog post](https://ipshipyard.com/blog/2025-js-libp2p-devtools/).
14
15 # Packages
16
17 - [`packages/libp2p-devtools`](https://github.com/ipshipyard/js-libp2p-inspector/tree/main/packages/libp2p-devtools) Browser DevTools plugin to inspect a libp2p node running on the current page
18 - [`packages/libp2p-inspector`](https://github.com/ipshipyard/js-libp2p-inspector/tree/main/packages/libp2p-inspector) Electron app to inspect a running libp2p node in node.js
19 - [`packages/libp2p-inspector-metrics`](https://github.com/ipshipyard/js-libp2p-inspector/tree/main/packages/libp2p-inspector-metrics) Collect libp2p metrics and send them to inspector (DevTools or Inspector)
20 - [`packages/libp2p-inspector-ui`](https://github.com/ipshipyard/js-libp2p-inspector/tree/main/packages/libp2p-inspector-ui) The user interface for inspecting a libp2p node
21
22 # API Docs
23
24 - <https://ipshipyard.github.io/js-libp2p-inspector>
25
26 # License
27
28 Licensed under either of
29
30 - Apache 2.0, ([LICENSE-APACHE](https://github.com/ipshipyard/js-libp2p-inspector/blob/main/LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
31 - MIT ([LICENSE-MIT](https://github.com/ipshipyard/js-libp2p-inspector/blob/main/LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
32
33 # Contribution
34
35 Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.