1.0.4 • Published 5 months ago

@ipshipyard/libp2p-inspector v1.0.4

Weekly downloads
-
License
Apache-2.0 OR MIT
Repository
github
Last release
5 months ago

@ipshipyard/libp2p-inspector

codecov CI

Inspect a running libp2p node

About

An electron app that bundles @ipshipyard/libp2p-inspector-ui for use with libp2p nodes running under Node.js or (eventually) in browsers.

libp2p-inspector running in Electron

Installation instructions

1. libp2p configuration

Configure @ipshipyard/libp2p-inspector-metrics as your metrics implementation:

import { createLibp2p } from 'libp2p'
import { inspectorMetrics } from '@ipshipyard/libp2p-inspector-metrics'

const node = await createLibp2p({
  metrics: inspectorMetrics(),
  //... other options her
})

2. Install the inspector

$ npm i -g @ipshipyard/libp2p-inspector

3. Run

$ libp2p-inspector

Local libp2p nodes running the @ipshipyard/libp2p-inspector-metrics metrics implementation will advertise themselves via MDNS and should appear in the app.

License

Licensed under either of

Contribution

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.