Home

Awesome

ncTelegram

A ncurses Telegram client developed in Python with the urwid library.

<p align="center"> <img src="screenshot.png" alt="screenshot of ncTelegram"/> </p>

:warning: I don't have time anymore to maintain this project, so you may experience unresolved bugs. Feel free to give tg a try as it seems like a good alternative. Though if anyone wants to contribute to ncTelegram I will be happy to review and merge PR.

Dependencies

Installation

Arch Linux:

You can use the pkgbuild from AUR:

$ yaourt -S nctelegram-git

OR

$ pacaur -y nctelegram-git

Fedora:

Install dependencies:

$ sudo dnf install telegram-cli python3-urwid python3-psutil python3-pip

Install ncTelegram through pip:

$ sudo pip3 install --upgrade https://github.com/Nanoseb/ncTelegram/archive/master.tar.gz

If you want notifications and inline images:

$ sudo dnf install libnotify caca-utils

Debian/Ubuntu:

To install telegram-cli just follow its readme.

Install urwid:

$ sudo apt-get install python3-urwid python3-psutil python3-pip

Install ncTelegram through pip:

$ sudo pip3 install --upgrade https://github.com/Nanoseb/ncTelegram/archive/master.tar.gz

If you want notifications and inline images:

$ sudo apt-get install libnotify-bin caca-utils

Crux:

Install repository:

$ wget -O /etc/ports/wildefyr.httpup "https://crux.nu/portdb/?a=getup&q=wildefyr"
$ ports -u

Install ncTelegram:

$ prt-get depinst nctelegram

If you want notifications and inline images:

$ prt-get depinst libnotify libcaca

Usage

Before the first run of nctelegram, telegram-cli must be launched first in order to register your account on your machine for the first time. (phone number and verification code).

An example of the configuration file can be found in /etc/ncTelegram.conf, copy it to your personal folder before modifying it:

$ cp /etc/ncTelegram.conf ~/.ncTelegram.conf

Finally, make sure that the path of telegram-cli and the public key are set correctly in ~/.ncTelegram.conf.

Tips

Troubleshooting

If nctelegram crashes, please report the issue with a backtrace if possible.

Before restarting nctelegram again, check if telegram-cli is still running; if so kill it before restarting nctelegram.