Warning
This project is still in development and is not ready for use.
A simple TUI for Telegram
tgt is a terminal user interface for Telegram, written in Rust.
Contributions to this project are welcome! If you have any suggestions, improvements, or bug fixes, feel free to submit a pull request. For more information, do not hesitate to contact us (see the Contact section).
Using the download-tdlib feature of tdlib-rs you do not need to set any environment variable. Then you can compile tgt using cargo build --features download-tdlib.
Instead, by default tgt assume that you have the tdlib built and the LOCAL_TDLIB_PATH environment variable set to the path of the tdlib directory. Or you can use pkg-config to find the path of the library, in this case see the CONTRIBUTING.md file for more information.
Remember to set the API_HASH and API_ID environment variables with the values of your Telegram application, you can get them from here or for the development you can use the following values:
export API_HASH="a3406de8d171bb422bb6ddf3bbd800e2"
export API_ID="94575"The CONTRIBUTING.md file contains information for building tgt and the steps to configure the tdlib in your local environment, starting from the compilation to the configuration of the environment variables.
You can find the road map of the project here (in the pinned issues).
You can use just, make or cargo, as build tools.
If you want to use cargo, please make sure to read the Justfile or the Makefile to understand the flags used for each command.
Here are the available commands:
just COMMAND
make COMMAND
COMMAND:
all # Run fmt, clippy and test
build_local # Build the project using cargo; you need to have setup the LOCAL_TDLIB_PATH environment variable
build_download # Build the project using cargo; it will download the tdlib library thanks to the tdlib-rs crate
run_local # Run the project using cargo; you need to have setup the LOCAL_TDLIB_PATH environment variable
run_download # Run the project using cargo; it will download the tdlib library thanks to the tdlib-rs crate
fmt # Format the code using cargo
clippy # Format the code using nightly cargo
test # Run clippy using cargo
clean # Run tests using cargo
help # Clean the project using cargo
This repository are licensed under either of
-
Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
-
MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
Please review the license file provided in the repository for more information regarding the terms and conditions of the license.