libervia-backend/doc/libervia-cli/serverless.rst
Goffi 53a83b6042 doc (cli/serverless): serverless commands documentation:
Document the commands `discover` and `info`.

fix 479
2026-07-17 23:27:47 +02:00

54 lines
1.5 KiB
ReStructuredText

=======================================
serverless: XMPP network without server
=======================================
The ``serverless`` commands is used for managing direct XMPP connection to peers, without
using XMPP server. Others peers must be capable to handle serverless connection.
.. note::
Serverless is a work in progress. This is very experimental, and it is using a
different stack than the history XEP-0174. For the moment, only Libervia is
implementing this, but the long term goal is to specify everything needed for other
clients to implement it too.
info
====
Show information about the serverless device configuration. For now, it displays the
device ID, the service name used for LAN discovery, and the number of currently discovered
peers.
example
-------
Show serverless device information::
$ li serverless info
discover
========
Discover peers on the local network. It shows a table with the discovered peers, their
names, device IDs, and network addresses.
Use ``-v, --verbose`` to also display metadata associated with each peer.
Use ``-f, --follow`` to keep the command running and monitor for new or lost peers in
real-time. In follow mode, a new table is printed each time a peer appears or disappears.
Press ``Ctrl+C`` to stop monitoring.
example
-------
Discover peers on the local network::
$ li serverless discover
Discover peers with verbose output::
$ li serverless discover -v
Monitor for peers in real-time::
$ li serverless discover -f