telecommander/README.md

Telecommander

The experimental full-featured curses-like command line client for Telegram is in heavy development, but also already usable!

It uses enricostara's telegram.link to connect to Telegram and chjj's blessed for the UI.

What it can and can't do

As of now, Telecommander lets you:

• Sign up for telegram
  • not sure it totally works, not really the priority for now
• Sign in with a code sent via SMS or telegram
• Keep signed in until you delete the files stored in ~/.config/telecommander or the session expires
• Do everything completely in the terminal, even via ssh
• Navigate your contact and chat list using the mouse
• Do basic usage with no complicated commands to learn
• Chat with your friends!
• Chat in groups!

For version 0.1.0 (Almost done!):

• Notifications
• Online Status viewing and management
• Automatic marking of messages as read

What's missing (for future versions up to 1.0)

• Scrolling back to view old messages
• Create, modify, manage groups
• Secret chats
• Manage your contacts
• Manage your profile
• Easy bot interaction
• Send and download files, audio messages, images
• Open links
• Emoticons (they show up as question marks)
• Sign out (without having to manually delete files)
• Delete account
• Reply to and Forward message support
• Do everything (except writing, duh) with the mouse!
• Cool interface (it's already ok, just not as cool as I want it to be)
• Search, Tab completion, command history
• Themes and configurability! Basic scripting!
• Optimization and automatic datacenter switching

What could be available after 1.0:

• polished plugin API, scripting support
• Telecommander as a library
• Parsable output mode
• More cool stuff!

A lot of features depend on telegram.link's still incomplete implementation sadly, but it'll come around eventually.

Hacking

To start Telecommander from source you'll need:

• npm, most of the time packaged with node
• python version 2.x (probably need a recent one)
• git to download the source

Let's set it up:

$ git clone https://github.com/fazo96/Telecommander.git
$ cd Telecommander

# If you just need to test it

$ npm install
$ ./telecommander.js

# If you want to install it

# Try with sudo if it doesn't work
$ npm install -g .
$ telecommander

# If npm install fails because of something about "gyp"
# it means your python points to python 3
# either swap it with python 2 or if you're on arch linux
# and/or your python 2 executable is "python2" just run this:

$ PYTHON=python2 npm install [-g .] 

PLEASE READ: if you fork the project and want to create a custom version of Telecommander please change the app.id and app.hash values in the source (should be in the first 30 lines of code) to the ones you can get (for free) from http://my.telegram.org

License

The MIT License (MIT)

Copyright (c) 2015 Enrico Fasoli (fazo96)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.