# PRE-INSTALLATION
Before you install `jami-commander` with `pip install jami-commander`
you *must* have followed these prerequisites steps!
- You must have Python 3.12+ installed. 3.11 might work.
- Run `python -V` to get your Python version number.
- Read the README.md file to see how to install and run Jami daemon `jamid`.
# jami-commander
Jami (https://jami.net) is a privacy-preserving peer-to-peer communication application available on many platforms. `Jami` is in concept similar to `Keet` (https://keet.io), both are peer-to-peer and use servers as little as possible. As a chat app it is similar to `Matrix` (https://http://matrix.org) as both can be self-hosted.
`jami-commander` (`jc` for short) is a simple but convenient CLI-based Jami client app for setting up accounts and swarms as well as sending.
`jami-commander` helps to set up a Jami account, configure the account and send messages and files to Jami peers. It provides the minimal set of commands to use `Jami` from the CLI.
The objective of `jami-commander` is to:
+ be able to use `Jami` from the terminal, the CLI, via SSH, and on head-less servers without monitor.
+ to use minimal resources. No Jami front-end (GUI) needs to be installed.
+ to be able to perform minimal operations to run a bot, e.g. to publish daily weather information
+ be simple. It is written in Python.
Functionality is minimal. You are invited to help to improve `jami-commander`. Pull requests are welcome.
# Installation and Prerequisites
+ `jami-commander` is only a client. It requires the Jami `jamid` daemon to run to performs the work.
+ first install Jami daemon `jamid` as follows:
+ e.g. on Fedora 40 (see https://jami.net/download-jami-linux/ for details)
+ `sudo dnf-3 config-manager --add-repo https://dl.jami.net/stable/fedora_40/jami-stable.repo # add the Jami repo`
+ `sudo dnf install jami-daemon # install only the jamid daemon`
+ e.g. on Ubuntu 24.04 (see https://jami.net/download-jami-linux/ for details)
+ ```sudo apt install gnupg dirmngr ca-certificates curl --no-install-recommends
curl -s https://dl.jami.net/public-key.gpg | sudo tee /usr/share/keyrings/jami-archive-keyring.gpg > /dev/null
sudo sh -c "echo 'deb [signed-by=/usr/share/keyrings/jami-archive-keyring.gpg] https://dl.jami.net/stable/ubuntu_24.04/ jami main' > /etc/apt/sources.list.d/jami.list"
sudo apt-get update && sudo apt-get install jami-daemon # install only the jamid daemon```
+ This installs around 204MB on Ubuntu
+ second install dependencies
+ e.g. Ubuntu 24.04
+ `sudo apt install libdbus-1-dev libglib2.0-dev libcairo2-dev libgirepository1.0-dev`
+ third install `jami-commander`
+ `pip install jami-commander`
+ see also https://pypi.org/pypi/jami-commander
+ run the `jamid` daemon:
+ e.g. on Fedora 40, similar on Ubuntu 24.04, etc.
+ `/usr/libexec/jamid -p & # start the jamid daemon`
+ now you can start and run the `jami-commander`
+ try `jami-commander -h` first to see what is available
# Features
```
jami-commander supports these arguments:
--usage
Print usage.
-h, --help
Print help.
--manual
Print manual.
--readme
Print README.md file.
-d, --debug
Print debug information.
--log-level DEBUG|INFO|WARNING|ERROR|CRITICAL [DEBUG|INFO|WARNING|ERROR|CRITICAL ...]
Set the log level(s).
--verbose
Set the verbosity level.
--get-enabled-accounts
List all enabled accounts by ids.
--add-account ALIAS HOSTNAME USERNAME PASSWORD
Add a new Jami account.
--remove-account ACCOUNTID [ACCOUNTID ...]
Remove a Jami account.
--get-conversations
List all swarm conversations by ids.
--add-conversation
Add a conversation to an account.
--remove-conversation
Remove one or multiple conversations from an account.
--get-conversation-members
List all members of one or multiple swarm conversations by ids.
--add-conversation-member USERID [USERID ...]
Add member(s) to one or multiple swarm conversations.
--remove-conversation-member USERID [USERID ...]
Remove member(s) from one or multiple swarm conversations.
-a ACCOUNTID, --account ACCOUNTID
Connect to and use the specified account.
-c CONVERSATIONID [CONVERSATIONID ...], --conversations CONVERSATIONID [CONVERSATIONID ...]
Specify one or multiple swarm conversations.
-m TEXT [TEXT ...], --message TEXT [TEXT ...]
Send one or multiple text messages.
-f FILE [FILE ...], --file FILE [FILE ...]
Send one or multiple files (e.g. PDF, DOC, MP4).
-w, --html
Send message as format "HTML".
-z, --markdown
Send message as format "MARKDOWN".
-k, --code
Send message as format "CODE".
-j, --emojize
Send message after emojizing.
--split SEPARATOR
Split message text into multiple Jami messages.
--separator SEPARATOR
Set a custom separator used for certain print outs.
-o TEXT|JSON, --output TEXT|JSON
Select an output format.
-v [PRINT|CHECK], -V [PRINT|CHECK], --version [PRINT|CHECK]
Print version information or check for updates.
```
Raw data
{
"_id": null,
"home_page": "https://github.com/8go/jami-commander",
"name": "jami-commander",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "Jami, chat, messaging, CLI",
"author": "8go",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/81/cb/d9600cdce4f62df32d2e59e13358e07b6a3d52b0db9e2122b4e78ca38f0e/jami_commander-0.8.0.tar.gz",
"platform": null,
"description": "# PRE-INSTALLATION\n\nBefore you install `jami-commander` with `pip install jami-commander`\nyou *must* have followed these prerequisites steps!\n\n- You must have Python 3.12+ installed. 3.11 might work.\n- Run `python -V` to get your Python version number.\n- Read the README.md file to see how to install and run Jami daemon `jamid`. \n\n# jami-commander\n\nJami (https://jami.net) is a privacy-preserving peer-to-peer communication application available on many platforms. `Jami` is in concept similar to `Keet` (https://keet.io), both are peer-to-peer and use servers as little as possible. As a chat app it is similar to `Matrix` (https://http://matrix.org) as both can be self-hosted.\n\n`jami-commander` (`jc` for short) is a simple but convenient CLI-based Jami client app for setting up accounts and swarms as well as sending.\n\n`jami-commander` helps to set up a Jami account, configure the account and send messages and files to Jami peers. It provides the minimal set of commands to use `Jami` from the CLI.\n\nThe objective of `jami-commander` is to:\n\n+ be able to use `Jami` from the terminal, the CLI, via SSH, and on head-less servers without monitor.\n+ to use minimal resources. No Jami front-end (GUI) needs to be installed.\n+ to be able to perform minimal operations to run a bot, e.g. to publish daily weather information\n+ be simple. It is written in Python.\n\nFunctionality is minimal. You are invited to help to improve `jami-commander`. Pull requests are welcome.\n\n# Installation and Prerequisites\n\n+ `jami-commander` is only a client. It requires the Jami `jamid` daemon to run to performs the work.\n+ first install Jami daemon `jamid` as follows:\n + e.g. on Fedora 40 (see https://jami.net/download-jami-linux/ for details)\n + `sudo dnf-3 config-manager --add-repo https://dl.jami.net/stable/fedora_40/jami-stable.repo # add the Jami repo`\n + `sudo dnf install jami-daemon # install only the jamid daemon`\n + e.g. on Ubuntu 24.04 (see https://jami.net/download-jami-linux/ for details)\n + ```sudo apt install gnupg dirmngr ca-certificates curl --no-install-recommends\ncurl -s https://dl.jami.net/public-key.gpg | sudo tee /usr/share/keyrings/jami-archive-keyring.gpg > /dev/null\nsudo sh -c \"echo 'deb [signed-by=/usr/share/keyrings/jami-archive-keyring.gpg] https://dl.jami.net/stable/ubuntu_24.04/ jami main' > /etc/apt/sources.list.d/jami.list\"\nsudo apt-get update && sudo apt-get install jami-daemon # install only the jamid daemon```\n + This installs around 204MB on Ubuntu\n+ second install dependencies\n + e.g. Ubuntu 24.04\n + `sudo apt install libdbus-1-dev libglib2.0-dev libcairo2-dev libgirepository1.0-dev`\n+ third install `jami-commander`\n + `pip install jami-commander`\n + see also https://pypi.org/pypi/jami-commander\n+ run the `jamid` daemon:\n + e.g. on Fedora 40, similar on Ubuntu 24.04, etc.\n + `/usr/libexec/jamid -p & # start the jamid daemon`\n+ now you can start and run the `jami-commander`\n + try `jami-commander -h` first to see what is available\n\n# Features\n\n```\njami-commander supports these arguments:\n\n--usage\n Print usage.\n-h, --help\n Print help.\n--manual\n Print manual.\n--readme\n Print README.md file.\n-d, --debug\n Print debug information.\n--log-level DEBUG|INFO|WARNING|ERROR|CRITICAL [DEBUG|INFO|WARNING|ERROR|CRITICAL ...]\n Set the log level(s).\n--verbose\n Set the verbosity level.\n--get-enabled-accounts\n List all enabled accounts by ids.\n--add-account ALIAS HOSTNAME USERNAME PASSWORD\n Add a new Jami account.\n--remove-account ACCOUNTID [ACCOUNTID ...]\n Remove a Jami account.\n--get-conversations\n List all swarm conversations by ids.\n--add-conversation\n Add a conversation to an account.\n--remove-conversation\n Remove one or multiple conversations from an account.\n--get-conversation-members\n List all members of one or multiple swarm conversations by ids.\n--add-conversation-member USERID [USERID ...]\n Add member(s) to one or multiple swarm conversations.\n--remove-conversation-member USERID [USERID ...]\n Remove member(s) from one or multiple swarm conversations.\n-a ACCOUNTID, --account ACCOUNTID\n Connect to and use the specified account.\n-c CONVERSATIONID [CONVERSATIONID ...], --conversations CONVERSATIONID [CONVERSATIONID ...]\n Specify one or multiple swarm conversations.\n-m TEXT [TEXT ...], --message TEXT [TEXT ...]\n Send one or multiple text messages.\n-f FILE [FILE ...], --file FILE [FILE ...]\n Send one or multiple files (e.g. PDF, DOC, MP4).\n-w, --html\n Send message as format \"HTML\".\n-z, --markdown\n Send message as format \"MARKDOWN\".\n-k, --code\n Send message as format \"CODE\".\n-j, --emojize\n Send message after emojizing.\n--split SEPARATOR\n Split message text into multiple Jami messages.\n--separator SEPARATOR\n Set a custom separator used for certain print outs.\n-o TEXT|JSON, --output TEXT|JSON\n Select an output format.\n-v [PRINT|CHECK], -V [PRINT|CHECK], --version [PRINT|CHECK]\n Print version information or check for updates.\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "A simple command-line Jami (jami.net) client",
"version": "0.8.0",
"project_urls": {
"Bug Tracker": "https://github.com/8go/jami-commander/issues",
"Homepage": "https://github.com/8go/jami-commander",
"repository": "https://github.com/8go/jami-commander"
},
"split_keywords": [
"jami",
" chat",
" messaging",
" cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "16d1eed1484479c80058eef30598e5e24801e988dde7f4dda2def2bb079efa6b",
"md5": "e5394d178242c082bf59007c90a42ffc",
"sha256": "f513b96fc288d683cae3cf1398956f954940f4fe794cf9050cdf05870674a554"
},
"downloads": -1,
"filename": "jami_commander-0.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e5394d178242c082bf59007c90a42ffc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 43740,
"upload_time": "2024-08-25T15:11:48",
"upload_time_iso_8601": "2024-08-25T15:11:48.164541Z",
"url": "https://files.pythonhosted.org/packages/16/d1/eed1484479c80058eef30598e5e24801e988dde7f4dda2def2bb079efa6b/jami_commander-0.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "81cbd9600cdce4f62df32d2e59e13358e07b6a3d52b0db9e2122b4e78ca38f0e",
"md5": "3e0db9d03a252de8606ddddfffafd4c7",
"sha256": "ec2b898054fe172ede641aa4cfe4b64a3e45894b1154fe1fc1a432b63f4306ae"
},
"downloads": -1,
"filename": "jami_commander-0.8.0.tar.gz",
"has_sig": false,
"md5_digest": "3e0db9d03a252de8606ddddfffafd4c7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 43789,
"upload_time": "2024-08-25T15:11:49",
"upload_time_iso_8601": "2024-08-25T15:11:49.830339Z",
"url": "https://files.pythonhosted.org/packages/81/cb/d9600cdce4f62df32d2e59e13358e07b6a3d52b0db9e2122b4e78ca38f0e/jami_commander-0.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-25 15:11:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "8go",
"github_project": "jami-commander",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "argparse",
"specs": []
},
{
"name": "asyncio",
"specs": []
},
{
"name": "async-timeout",
"specs": []
},
{
"name": "dbus-python",
"specs": []
},
{
"name": "emoji",
"specs": []
},
{
"name": "markdown",
"specs": []
},
{
"name": "PyGObject",
"specs": []
},
{
"name": "uuid",
"specs": []
}
],
"lcname": "jami-commander"
}
JSON
