XMPPC(1)

📦
version 0.1.2 · 4 versions
, in alpine 3.24, debian bookworm, debian trixie, nixos 26.05, nixpkgs unstable, opensuse-leap 16.0, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

okay so bestie, welcome to XMPPC(1) — the XMPP command line tool, and honestly? iconic. We’re gonna go through every flag, mode, file, and tiny little detail together, no cap. 💖✨

🌸 NAME 🌸

xmppc — XMPP Command line Tool. That’s the whole name, and it’s giving “small binary, big group-chat energy.” 💅

🦋 SYNOPSIS 🦋

xmppc [OPTIONS] -m MODE COMMAND [<args>...]

xmppc [-a ACCOUNT] [-j JID] [-p PASSWORD] -m MODE COMMAND [<args>...]

✨ DESCRIPTION ✨

okay so xmppc is an XMPP command line tool. You need an XMPP Account to use it — no account, no slay. The account info can be defined via the command line argument -j JID.

If no password is provided via -p PASSWORD, xmppc will ask the user to enter the password. Another option is to define 1 or more accounts within a configuration file, and -a ACCOUNT can be used to select the account. 🫶

The argument -m MODE defines the xmppc MODE which should be used (roster, message, pgp, omemo, openpgp, monitor, bookmark, mam, discovery). The COMMAND and the args required by the COMMAND depend on the chosen MODE. iykyk ✨

💅 OPTIONS 💅

  • -a, --attribute ACCOUNT — ACCOUNT is a name of a xmpp account defined within the configuration file. pick your account, bestie 🎀
  • -j, --jid JID — JID of the XMPP Account. literally your XMPP identity 💖
  • -p, --pwd PWD — Password of the XMPP Account. secret secret, don’t tell anyone 🙈
  • -v VERBOSE, Verbose flags. -v[v[v[v]]] — verbosity flags, bestie: -v is WARN, -vv is INFO, --vvv is DEBUG, -vvvv is TRACE. yes, that --vvv is exactly what the page says — don’t come for me 😭
  • --help — Print program version number and help. short, sweet, helpful 🫶

🌈 MODES AND COMMANDS 🌈

okay, xmppc modes. Pick your main character with -m, then run the command. ✨

  • -m roster — The Roster mode can be used to provide information of the xmpp account’s roster. The roster is the XMPP list of contacts. 👑
    • list — List all contacts
    • export — Exports all contacts
  • -m message — The message mode can be used to send unencrypted messages to another xmpp account. 💌
    • chat <jid> <message> — Sending unencrypted message to jid
  • -m pgp — PGP Mode (XEP-0027) 🔐
    • chat <jid> <message> — Sending pgp encrypted message to jid
  • -m omemo — OMEMO Mode (XEP-0384) 🦋
    • list — List the device IDs and fingerprints
  • -m openpgp — openpgp mode (XEP-0373) 🔥
    • signcrypt <jid> <message> — Sending pgp signed and encrypted message to jid
  • -m monitor — Monitot mode. yes, “Monitot” is exactly how the page spells it, bestie 😭
    • stanza — Stanza Monitor
    • monitor — microblog Monitor microblog (XEP-0277)
  • -m bookmark — Bookmark mode (XEP-0048) 🎀
    • list — List bookmarks
  • -m mam — Message Archive Management (XEP-0313) 🗂️
    • list <jid> — List messages from <jid>
  • -m discovery — Service Discovery (XEP-0030) 🔎
    • info <jid> — info request for <jid>
    • item <jid> — item request for <jid>

🍓 ENVIRONMENT VARIABLES 🍓

the page lists exactly one env var, and honestly? she’s lowkey carrying the whole config vibe:

  • HOME — that’s the one, bestie 🏠

🔥 EXAMPLES 🔥

run these exactly as written; the quotes and flags matter, bestie:

xmppc --jid user@domain.tld --pwd "secret" --mode roster list
xmppc --jid user@domain.tld --mode pgp chat friend@domain.tld "Hello"
xmppc -a account1 --mode discovery item conference@domain.tld
xmppc --mode bookmark list

🎀 FILES 🎀

Configuration file to setup accounts.

~/.config/xmppc.conf — Example:

[default]
jid=account1@domain.tld
pwd=password1

[account2]
jid=account2@domain.tld

[account3]
jid=account3@domain.tld
pwd=password3

💀 EXIT STATUS 💀

  • 0 — Success. slay. ✨
  • 1 — Failure. not slay. 😭

🙈 BUGS 🙈

See https://codeberg.org/Anoxinon_e.V./xmppc/issues — that’s the issue tracker, bestie. 🐛

👑 AUTHOR 👑

  • DebXWoody (OpenPGP: A602F76893F138B4A8EFDDD5C2DC916F35751C24)

🌟 RESOURCES 🌟

💜 COPYING 💜

Copyright (C) 2020 Anoxinon e.V. Free use of this software is granted under the terms of the GNU General Public License (GPL).

okay that’s the whole page — stay hydrated, stay iconic, and may your stanzas always land. 🫶 This was the XMPPC(1) manual page, dated 05/16/2020 🎀✨

📦 where this page comes from