UNPKG

1.4 kBMarkdownView Raw
1# xapi-inspector
2
3[![Node compatibility](https://badgen.net/npm/node/xapi-inspector)](https://npmjs.org/package/xapi-inspector) [![License](https://badgen.net/npm/license/xapi-inspector)](https://npmjs.org/package/xapi-inspector) [![PackagePhobia](https://badgen.net/packagephobia/install/xapi-inspector)](https://packagephobia.now.sh/result?p=xapi-inspector)
4
5[![Package Version](https://badgen.net/npm/v/xapi-inspector)](https://npmjs.org/package/xapi-inspector) [![Latest Commit](https://badgen.net/github/last-commit/vatesfr/xapi-inspector)](https://github.com/vatesfr/xapi-inspector/commits/master)
6
7> \${pkg.description}
8
9## Install
10
11Installation of the [npm package](https://npmjs.org/package/xapi-inspector):
12
13```sh
14npm install --global xapi-inspector
15```
16
17Or:
18
19```sh
20yarn global add xapi-inspector
21```
22
23## Usage
24
25```
26Usage: xapi-inspector proxy [--bind <local address>] <remote address>
27
28 Create a XML-RPC proxy which forward requests from <local address>
29 to <remote address>.
30
31 <local address>: [<hostname>]:<port>
32 <remote address>: <hostname>[:<port = 443>]
33```
34
35## Contributions
36
37Contributions are _very_ welcomed, either on the documentation or on
38the code.
39
40You may:
41
42- report any [issue](https://github.com/vatesfr/xapi-inspector/issues)
43 you've encountered;
44- fork and create a pull request.
45
46## License
47
48[ISC](https://spdx.org/licenses/ISC) © [Vates SAS](https://vates.fr)