TTTC/README.md
2019-11-04 00:47:04 +00:00

38 lines
1.4 KiB
Markdown

# TTTC, the telegram client
TTTC is an unofficial [Telegram](https://telegram.org/) commandline client.
It aims to provide a user experience similar to that of [VIM](https://www.vim.org/).
## Requirements
TTTC uses the `curses` and `telethon` python libraries. Curses is usually shipped with
your python installation, but `telethon` can easily be installed via `pip`.
In order to use TTTC, you will need your own Telegram `api_id` and `api_hash`.
You can read more about how to get them [here](https://core.telegram.org/api/obtaining_api_id).
Once you obtained your own api key and hash, you need to set them as your environment variables
`TTTC_API_ID` and `TTTC_API_HASH`, respectively.
The client can be run with `python3 tttc.py`.
## Keybindings
Currently, there is no way of changing the keybindings in a config. This is subject to change in a future update.
The default key bindings are
| Key | Function |
| ---- | ---- |
| i | Enter insert mode (to compose a message) |
| y, Return | Send message |
| Esc | Cancel, Exit current mode |
| c/C | Previous/Next Dialog |
| E | Toggle emoji ASCII display |
| `n` e | Edit message `n` (ESC to open prompt to save changes) |
| `n` r | Reply to message `n` (submit draft) |
| `n` d | Delete message `n` |
| / | enter search mode |
| n/N | Previous/Next search result |
| Q | exit TTTC |
| q `r` | Record macro into register `r` |