https://github.com/captain-n3m0/matrixterm

MatrixTerm is a command-line interface (CLI) client for Matrix, a decentralized communication protocol. This Python-based CLI client allows you to interact with Matrix chat rooms, join rooms, send messages, and more.
https://github.com/captain-n3m0/matrixterm

Last synced: 5 days ago
JSON representation

MatrixTerm is a command-line interface (CLI) client for Matrix, a decentralized communication protocol. This Python-based CLI client allows you to interact with Matrix chat rooms, join rooms, send messages, and more.

• Host: GitHub
• URL: https://github.com/captain-n3m0/matrixterm
• Owner: captain-n3m0
• License: mit
• Created: 2023-08-25T13:21:37.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-11-17T03:51:40.000Z (about 2 months ago)
• Last Synced: 2024-11-17T04:28:19.160Z (about 2 months ago)
• Language: Python
• Homepage:
• Size: 651 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# MatrixTerm CLI Client

MatrixTerm is a command-line interface (CLI) client for Matrix, a decentralized communication protocol. This Python-based CLI client allows you to interact with Matrix chat rooms, join rooms, send messages, and more.

![MatrixTerm Screenshot](.screenshots/matrixterm_screenshot.png)

## Features

- **List Joined Rooms:** View a list of rooms you have joined.

- **Join a Matrix Room:** Easily join Matrix rooms using room IDs.

- **Send Messages:** Send text messages to any room you are part of.

- **Interactive CLI:** Enjoy a clean and interactive command-line interface for seamless navigation.

- **Asynchronous Operation:** Built on `asyncio` for responsive and efficient performance.

- **Configuration File Support:** Save your Matrix server and login credentials for quick access.

- **Room Management:** Leave rooms and manage your room list effectively.

- **Message History Retrieval:** Fetch and view message history within any room.

## Installation

1. Clone this repository:

   ```bash

   git clone https://github.com/captain-n3m0/MatrixTerm.git

   cd MatrixTerm

2. Install the required dependencies:

   ```bash

   pip install -r requirements.txt

   ```

3. Usage:

   ```bash

   python matrixterm.py --homeserver MATRIX_HOMESERVER_URL --username YOUR_USERNAME --password YOUR_PASSWORD

   ```

LICENSE: This project is licensed under the terms of the MIT license.

4. Contributing

   Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.