Code Monkey home page Code Monkey logo

telminal's Introduction

telminal

A Terminal in Telegram!

There is a lovely messenger in the world that has so many features that we can manage our Linux server with those features.

What is this?

Telminal is a Python package that helps you have your own server assistant Telegram bot. You can use Telminal as a terminal or to download & upload files.

Telminal features

  • HTML and image output
  • Process state info
  • Interactive command support
  • Download from server
  • Upload to server
  • Multi user
  • Tasks

Getting Started

Prerequisites

You need telegram developer API and a bot token
API ID API hash
Bot token
Very fast and easy you can have those, just follow this two official links.

Installation

pip install telminal

Setup

setup.mp4

Run telminal command after installation finished. Telminal needs those Telegram tokens for first run.
Also you can create a config.json file inside the package directory in this format:

{
    "api_id": 1234,
    "api_hash": "abcs",
    "token": "efgh",
    "admins": [8888, 9999]
}

โš ๏ธ First admin can manage other admins, so order of admins list matter.
In this sample config 8888 must be your Telegram user ID.

Interactive Mode

interactive-mode.mp4

You can activate this mode for last running process by sending /interactive_mode or by clicking on Interactive mode button of each process.
In interactive mode you are talking to the process and each message means an input for that process.
Also a two characters message starts with ^ has own meaning and behave like a control command so ^c means CTRL + C.
To return to normal mode and creating a new process just use /normal_mode or Exit interactive mode button.

Optional image output

text-version.mp4

Image creation for process result is optimized and will be okay on a server with minimum resources.
However, creating an image on the server is an expensive process. so if you want to run multiple commands at once or have a process that does not require image output, I strongly recommend using the text version by sending \image_off command.

Download file from server

download-from-server.mp4

You can save any file (up to 2GB) of your server on telegram.
There are two ways to do this :

  • Inline query
  • !get command

Inline query just works for current directory and runs a ls -la | grep <your_query> in background.
With !get command you can specify path of a file manually.
Also you have a nice progress bar when you are downloading or uploading a heavy file.๐Ÿ˜Ž

Upload file to server

upload-to-server.mp4

Upload a file on your server just by sending to Telminal chat.
that file can be in telegram or on your hard disk.

Multi admin in group

multi-admin-multi-chat.mp4

Fortunately, all features can be used in a group too. by default, Telminal only responds to your commands.
!trust and !untrust are two commands that manage a user permission.
just reply to one of the user's messages with these commands.

Tasks

tasks.mp4

At this moment there is only one type of task.
A watcher task downloads a file periodically. write your first watcher in the following format:

!watch <number><s,m,h> <file_path>

Some real examples :

1๏ธโƒฃ get telminal.log every 50 seconds ๐Ÿ‘‰ !watch 50s telminal.log

2๏ธโƒฃ get temp.png every 5 minutes ๐Ÿ‘‰ !watch 5m home/temp.png

3๏ธโƒฃ get sql.dump every 24 hours ๐Ÿ‘‰ !watch 24h /backups/sql.dump


Finally set Telminal commands in Botfather using this text.

image_off - Just text output
image_on - Text and image output
tasks - List of active tasks
interacive_mode - Interact with last process
normal_mode - Process creation mode

Thanks

pexpect
Telethon
xterm.js
puppeteer

telminal's People

Contributors

fristhon avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.