README.md

 1# xmppc
 2
 3xmppc - command line interface (CLI) XMPP Client.
 4
 5xmppc is a XMPP command line interface client. It's written in C and is using
 6the xmpp library [libstrophe](http://strophe.im/libstrophe/).
 7
 8## Dependencies
 9
10* [libc6-dev](https://packages.debian.org/buster/libc6-dev) (2.28-10)
11* [libglib2.0-dev](https://packages.debian.org/buster/libglib2.0-dev) (2.58.3)
12* [libstrophe-dev](https://packages.debian.org/buster/libstrophe-dev) (0.9.2-2)
13* [libgpgme-dev](https://packages.debian.org/buster/libgpgme-dev) (1.12.0)
14
15## Build
16
17The project is using [GNU Automake](https://www.gnu.org/software/automake/).
18
19```
20aptitude install libstrophe-dev
21./bootstrap.sh
22./configure
23make
24```
25
26## Usage
27
28```
29xmppc --jid user@domain.tld --pwd "password" --mode roster list
30xmppc -j user@domain.tld -p "password" -m roster list
31xmppc -j user@domain.tld -p "password" -m roster export
32xmppc -j user@domain.tld -p "password" -m message chat friend@domain.tld "Message"
33xmppc -j user@domain.tld -p "password" -m pgp chat friend@domain.tld "Message"
34xmppc -j user@domain.tld -p "password" -m openpgp signcrypt friend@domain.tld "Message"
35xmppc -j user@domain.tld -p "password" -m omemo list
36xmppc -j user@domain.tld -p "password" -m monitor stanza
37```
38Use xmppc with [pass](https://packages.debian.org/buster/pass)
39
40```
41xmppc --jid user@domain.tld --pwd $(pass XMPP/domain.tld/user) --mode roster list
42```
43
44## Config file
45
46Config file: ` ~/.config/xmppc.conf`
47
48```
49[default]
50jid=user@domain.tld
51pwd=YourSecret
52```
53
54## Documentation
55
56* [Wiki](https://codeberg.org/Anoxinon_e.V./xmppc/wiki)
57
58## Contact details
59
60* MUC: xmpp-messenger@conference.anoxinon.me
61