Mercurial > libervia-backend
annotate doc/libervia-cli/index.rst @ 3934:e345d93fb6e5
plugin OXPS: OpenPGP for XMPP Pubsub implementation:
OpenPGP for XMPP Pubsub (https://xmpp.org/extensions/inbox/pubsub-encryption.html,
currently a protoXEP) is implemented and activated when `encrypted` is set to `True` in
pubsub's `extra` data.
On item retrieval, the decryption is transparent if the key is known, except if the
`decrypt` key in `extra` is set to `False` (notably useful when one wants to checks that
data is well encrypted).
Methods and corresponding bridge methods have been implemented to manage shared secrets
(to share, revoke or rotate the secrets).
plugin XEP-0060's `XEP-0060_publish` trigger point as been move before actual publish so
item can be modified (here e2ee) by the triggers. A new `XEP-0060_items` trigger point has
also been added.
`encrypted` flag can be used with plugin XEP-0277's microblog data
rel 380
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Sat, 15 Oct 2022 20:36:53 +0200 |
| parents | 4705f80b6e23 |
| children |
| rev | line source |
|---|---|
|
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3054
diff
changeset
|
1 .. _libervia-cli_documentation: |
|
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3054
diff
changeset
|
2 |
|
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3054
diff
changeset
|
3 ============ |
|
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3054
diff
changeset
|
4 Libervia CLI |
|
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3054
diff
changeset
|
5 ============ |
|
3021
8ec35cf13f66
doc: added, overview, configuration and Primitivus documentation + some small modifications
Goffi <goffi@goffi.org>
parents:
2946
diff
changeset
|
6 |
|
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3054
diff
changeset
|
7 Libervia CLI is the Command Line Interface of Libervia |
| 2946 | 8 |
|
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3054
diff
changeset
|
9 ``libervia-cli`` is the command to launch it. |
|
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3054
diff
changeset
|
10 |
|
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3054
diff
changeset
|
11 ``li`` is short alias for ``libervia-cli``, it is the command used through this |
|
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3054
diff
changeset
|
12 documentation. |
| 2946 | 13 |
| 14 Overview | |
| 15 ======== | |
| 16 | |
| 3505 | 17 ``li`` is a powerful tool to work with Libervia/XMPP. |
| 2946 | 18 With it you can send chat messages, share files, retrieve avatars, write blog entries, etc. |
| 19 | |
| 20 Usage | |
| 21 ===== | |
| 22 | |
| 23 To get help on commands or their options, use:: | |
| 24 | |
|
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3054
diff
changeset
|
25 $ li --help |
| 2946 | 26 |
| 27 which can be used on any command, so if you need help on ``message send`` command, just do:: | |
| 28 | |
|
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3054
diff
changeset
|
29 $ li message send --help |
| 2946 | 30 |
|
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3054
diff
changeset
|
31 With li, you always enter commands first, then options and arguments. |
| 2946 | 32 |
| 3054 | 33 There are several levels of commands: first one is the main category (``message``, |
| 2946 | 34 ``blog``, ``avatar``, etc.), then there are often subcommands (e.g. ``message send``). |
| 35 | |
| 36 After the commands come the options. For instance if you want to send a message, you can | |
| 37 get the available options with ``--help`` as explained above:: | |
| 38 | |
|
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3054
diff
changeset
|
39 $ li message send --help |
|
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3054
diff
changeset
|
40 usage: li message send [-h] [-p PROFILE] [--pwd PASSWORD] [-c] [-l LANG] [-s] |
| 2946 | 41 [-n] [-S SUBJECT] [-L SUBJECT_LANG] |
| 42 [-t {chat,error,groupchat,headline,normal,auto}] | |
| 43 [-e ALGORITHM] [--encrypt-noreplace] [-x | -r] | |
| 44 jid | |
| 45 | |
| 46 positional arguments: | |
| 47 jid the destination jid | |
| 48 | |
| 49 optional arguments: | |
| 50 -h, --help show this help message and exit | |
| 51 -p PROFILE, --profile PROFILE | |
| 52 Use PROFILE profile key (default: @DEFAULT@) | |
| 53 --pwd PASSWORD Password used to connect profile, if necessary | |
| 54 -c, --connect Connect the profile before doing anything else | |
| 55 -l LANG, --lang LANG language of the message | |
| 56 -s, --separate separate xmpp messages: send one message per line | |
| 57 instead of one message alone. | |
| 58 -n, --new-line add a new line at the beginning of the input (usefull | |
| 59 for ascii art ;)) | |
| 60 -S SUBJECT, --subject SUBJECT | |
| 61 subject of the message | |
| 62 -L SUBJECT_LANG, --subject_lang SUBJECT_LANG | |
| 63 language of subject | |
| 64 -t {chat,error,groupchat,headline,normal,auto}, --type {chat,error,groupchat,headline,normal,auto} | |
| 65 type of the message | |
| 66 -e ALGORITHM, --encrypt ALGORITHM | |
| 67 encrypt message using given algorithm | |
| 68 --encrypt-noreplace don't replace encryption algorithm if an other one is | |
| 69 already used | |
| 70 -x, --xhtml XHTML body | |
| 71 | |
| 72 If you want to send a message to, say, ``pierre@example.net``, and encrypt it with OMEMO, | |
| 73 just do the following:: | |
| 74 | |
|
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3054
diff
changeset
|
75 echo "hi, I'm writing with li" | li message send -e omemo pierre@example.net |
| 2946 | 76 |
| 77 (note that with OMEMO, you need to have previously validated fingerprint of your contact | |
| 78 for this to work). | |
| 79 | |
| 80 The different commands are explained in dedicated sections. | |
| 81 | |
| 82 .. toctree:: | |
|
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3054
diff
changeset
|
83 :caption: li commands: |
| 2946 | 84 :glob: |
| 85 :maxdepth: 2 | |
| 86 | |
| 87 common_arguments | |
| 88 * | |
| 89 | |
| 90 | |
| 91 Tutorial | |
| 92 ======== | |
| 93 | |
| 94 You can check this third party tutorial: https://blog.agayon.be/sat_jp.html |