Mercurial > libervia-backend
view doc/libervia-cli/index.rst @ 3888:aa7197b67c26
component AP gateway: AP <=> XMPP reactions conversions:
- Pubsub Attachments plugin has been renamed to XEP-0470 following publication
- XEP-0470 has been updated to follow 0.2 changes
- AP reactions (as implemented in Pleroma) are converted to XEP-0470
- XEP-0470 events are converted to AP reactions (again, using "EmojiReact" from Pleroma)
- AP activities related to attachments (like/reactions) are cached in Libervia because
it's not possible to retrieve them from Pleroma instances once they have been emitted
(doing an HTTP get on their ID returns a 404). For now those cache are not flushed, this
should be improved in the future.
- `sharedInbox` is used when available. Pleroma returns a 500 HTTP error when ``to`` or
``cc`` are used in a direct inbox.
- reactions and like are not currently used for direct messages, because they can't be
emitted from Pleroma in this case, thus there is no point in implementing them for the
moment.
rel 371
author | Goffi <goffi@goffi.org> |
---|---|
date | Wed, 31 Aug 2022 17:07:03 +0200 |
parents | 4705f80b6e23 |
children |
line wrap: on
line source
.. _libervia-cli_documentation: ============ Libervia CLI ============ Libervia CLI is the Command Line Interface of Libervia ``libervia-cli`` is the command to launch it. ``li`` is short alias for ``libervia-cli``, it is the command used through this documentation. Overview ======== ``li`` is a powerful tool to work with Libervia/XMPP. With it you can send chat messages, share files, retrieve avatars, write blog entries, etc. Usage ===== To get help on commands or their options, use:: $ li --help which can be used on any command, so if you need help on ``message send`` command, just do:: $ li message send --help With li, you always enter commands first, then options and arguments. There are several levels of commands: first one is the main category (``message``, ``blog``, ``avatar``, etc.), then there are often subcommands (e.g. ``message send``). After the commands come the options. For instance if you want to send a message, you can get the available options with ``--help`` as explained above:: $ li message send --help usage: li message send [-h] [-p PROFILE] [--pwd PASSWORD] [-c] [-l LANG] [-s] [-n] [-S SUBJECT] [-L SUBJECT_LANG] [-t {chat,error,groupchat,headline,normal,auto}] [-e ALGORITHM] [--encrypt-noreplace] [-x | -r] jid positional arguments: jid the destination jid optional arguments: -h, --help show this help message and exit -p PROFILE, --profile PROFILE Use PROFILE profile key (default: @DEFAULT@) --pwd PASSWORD Password used to connect profile, if necessary -c, --connect Connect the profile before doing anything else -l LANG, --lang LANG language of the message -s, --separate separate xmpp messages: send one message per line instead of one message alone. -n, --new-line add a new line at the beginning of the input (usefull for ascii art ;)) -S SUBJECT, --subject SUBJECT subject of the message -L SUBJECT_LANG, --subject_lang SUBJECT_LANG language of subject -t {chat,error,groupchat,headline,normal,auto}, --type {chat,error,groupchat,headline,normal,auto} type of the message -e ALGORITHM, --encrypt ALGORITHM encrypt message using given algorithm --encrypt-noreplace don't replace encryption algorithm if an other one is already used -x, --xhtml XHTML body If you want to send a message to, say, ``pierre@example.net``, and encrypt it with OMEMO, just do the following:: echo "hi, I'm writing with li" | li message send -e omemo pierre@example.net (note that with OMEMO, you need to have previously validated fingerprint of your contact for this to work). The different commands are explained in dedicated sections. .. toctree:: :caption: li commands: :glob: :maxdepth: 2 common_arguments * Tutorial ======== You can check this third party tutorial: https://blog.agayon.be/sat_jp.html