From 009d8ca1a75f8a984fb5bf04d0d03caaf22a5a0d Mon Sep 17 00:00:00 2001 From: altostratous Date: Mon, 30 May 2016 01:06:57 +0430 Subject: [PATCH] Edited readme --- README.md | 136 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 136 insertions(+) diff --git a/README.md b/README.md index 4a9e0fa..191c51c 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,142 @@ Command-line interface for [Telegram](http://telegram.org). Uses readline interface. +#Extended Telegram Cli (etcli) +This application is based on telegram-cli. + +###Added features: +- now "history" and "get_message" commands return views count for messages as well. +- now "channel_info" returns about channel (Channel description) as well. + +###Common use for channels +1 - channel_join Joins to channel +2 - channel_leave Leaves from channel +3 - history [limit] [offset] Prints messages with this peer (most recent message lower). Also marks messages as read, views are shown as "views" both in json and text. +4 - channel_info Prints info about channel (id, members, admin, description(about), name) +5 - get_message Get message by id, number of views is represented as "views" as well. + +###Commands in details based on telegram-cli: +accept_secret_chat Accepts secret chat. Only useful with -E option +add_contact Tries to add user to contact list +block_user Blocks user +broadcast + Sends text to several users at once +channel_get_admins [limit=100] [offset=0] Gets channel admins +channel_get_members [limit=100] [offset=0] Gets channel members +channel_info Prints info about channel (id, members, admin, etc.) +channel_invite Invites user to channel +channel_join Joins to channel +channel_kick Kicks user from channel +channel_leave Leaves from channel +channel_list [limit=100] [offset=0] List of last channels +channel_set_about Sets channel about info. +channel_set_admin Sets channel admin. 0 - not admin, 1 - moderator, 2 - editor +channel_set_username Sets channel username info. +channel_set_photo Sets channel photo. Photo will be cropped to square +chat_add_user [msgs-to-forward] Adds user to chat. Sends him last msgs-to-forward message from this chat. Default 100 +chat_del_user Deletes user from chat +chat_info Prints info about chat (id, members, admin, etc.) +chat_set_photo Sets chat photo. Photo will be cropped to square +chat_upgrade Upgrades chat to megagroup +chat_with_peer Interface option. All input will be treated as messages to this peer. Type /quit to end this mode +clear Clears all data and exits. For debug. +contact_list Prints contact list +contact_search username Searches user by username +create_channel + Creates channel with users +create_group_chat + Creates group chat with users +create_secret_chat Starts creation of secret chat +del_contact Deletes contact from contact list +delete_msg Deletes message +dialog_list [limit=100] [offset=0] List of last conversations +export_card Prints card that can be imported by another user with import_card method +export_channel_link Prints channel link that can be used to join to channel +export_chat_link Prints chat link that can be used to join to chat +fwd + Forwards message to peer. Forward to secret chats is forbidden +fwd_media Forwards message media to peer. Forward to secret chats is forbidden. Result slightly differs from fwd +get_terms_of_service Prints telegram's terms of service +get_message Get message by id +get_self Get our user info +help [command] Prints this help +history [limit] [offset] Prints messages with this peer (most recent message lower). Also marks messages as read +import_card Gets user by card and prints it name. You can then send messages to him as usual +import_chat_link Joins to chat by link +import_channel_link Joins to channel by link +load_audio Downloads file to downloads dirs. Prints file name after download end +load_channel_photo Downloads file to downloads dirs. Prints file name after download end +load_chat_photo Downloads file to downloads dirs. Prints file name after download end +load_document Downloads file to downloads dirs. Prints file name after download end +load_document_thumb Downloads file to downloads dirs. Prints file name after download end +load_file Downloads file to downloads dirs. Prints file name after download end +load_file_thumb Downloads file to downloads dirs. Prints file name after download end +load_photo Downloads file to downloads dirs. Prints file name after download end +load_user_photo Downloads file to downloads dirs. Prints file name after download end +load_video Downloads file to downloads dirs. Prints file name after download end +load_video_thumb Downloads file to downloads dirs. Prints file name after download end +main_session Sends updates to this connection (or terminal). Useful only with listening socket +mark_read Marks messages with peer as read +msg Sends text message to peer +msg Sends text message to peer with custom kbd +post Sends text message to peer as admin +post_audio Posts audio to peer +post_document Posts document to peer +post_file Sends document to peer +post_location Sends geo location +post_photo [caption] Sends photo to peer +post_text Sends contents of text file as plain text message +post_video [caption] Sends video to peer +quit Quits immediately +rename_channel Renames channel +rename_chat Renames chat +rename_contact Renames contact +reply Sends text reply to message +reply_audio Sends audio to peer +reply_contact Sends contact (not necessary telegram user) +reply_document Sends document to peer +reply_file Sends document to peer +reply_location Sends geo location +reply_photo [caption] Sends photo to peer +reply_video Sends video to peer +resolve_username username Searches user by username +safe_quit Waits for all queries to end, then quits +search [peer] [limit] [from] [to] [offset] pattern Search for pattern in messages from date from to date to (unixtime) in messages with peer (if peer not present, in all messages) +send_audio Sends audio to peer +send_contact Sends contact (not necessary telegram user) +send_document Sends document to peer +send_file Sends document to peer +send_location Sends geo location +send_photo [caption] Sends photo to peer +send_text Sends contents of text file as plain text message +send_typing [status] Sends typing notification. You can supply a custom status (range 0-10): none, typing, cancel, record video, upload video, record audio, upload audio, upload photo, upload document, geo, choose contact. +send_typing_abort Sends typing notification abort +send_video [caption] Sends video to peer +set Sets value of param. Currently available: log_level, debug_verbosity, alarm, msg_num +set_password Sets password +set_profile_name Sets profile name. +set_profile_photo Sets profile photo. Photo will be cropped to square +set_ttl Sets secret chat ttl. Client itself ignores ttl +set_username Sets username. +set_phone_number Changes the phone number of this account +show_license Prints contents of GPL license +start_bot Adds bot to chat +stats For debug purpose +status_online Sets status as online +status_offline Sets status as offline +unblock_user Unblocks user +user_info Prints info about user (id, last online, phone) +version Prints client and library version +view_audio Downloads file to downloads dirs. Then tries to open it with system default action +view_channel_photo Downloads file to downloads dirs. Then tries to open it with system default action +view_chat_photo Downloads file to downloads dirs. Then tries to open it with system default action +view_document Downloads file to downloads dirs. Then tries to open it with system default action +view_document_thumb Downloads file to downloads dirs. Then tries to open it with system default action +view_file Downloads file to downloads dirs. Then tries to open it with system default action +view_file_thumb Downloads file to downloads dirs. Then tries to open it with system default action +view_photo Downloads file to downloads dirs. Then tries to open it with system default action +view_user_photo Downloads file to downloads dirs. Then tries to open it with system default action +view_video Downloads file to downloads dirs. Then tries to open it with system default action +view_video_thumb Downloads file to downloads dirs. Then tries to open it with system default action +view Tries to view message contents +visualize_key Prints visualization of encryption key (first 16 bytes sha1 of it in fact) + ### API, Protocol documentation Documentation for Telegram API is available here: http://core.telegram.org/api