https://github.com/mcsmanager/pty

Cross-platform pseudo-teletype application
https://github.com/mcsmanager/pty

console go pseudo-teletype pty teletype terminal

Last synced: 5 months ago
JSON representation

Cross-platform pseudo-teletype application

• Host: GitHub
• URL: https://github.com/mcsmanager/pty
• Owner: MCSManager
• License: mit
• Created: 2022-07-01T02:57:39.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2024-09-29T09:51:39.000Z (8 months ago)
• Last Synced: 2024-12-06T00:12:07.583Z (6 months ago)
• Topics: console, go, pseudo-teletype, pty, teletype, terminal
• Language: Go
• Homepage: https://github.com/MCSManager/pty
• Size: 2.08 MB
• Stars: 25
• Watchers: 2
• Forks: 7
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# Pseudo-teletype App

[![--](https://img.shields.io/badge/Go_Version-1.19-green.svg)](https://github.com/MCSManager)

[![--](https://img.shields.io/badge/Support-Windows/Linux-yellow.svg)](https://github.com/MCSManager)

[![--](https://img.shields.io/badge/License-MIT-red.svg)](https://github.com/MCSManager)

English | [简体中文](README_CN.md)




## What is PTY?



![terminal image](https://user-images.githubusercontent.com/18360009/202891148-e7e5bf63-c4a9-454f-8f62-c91dc594cefa.png)



tty = "teletype"，pty = "pseudo-teletype"

In UNIX, /dev/tty\* is any device that acts like a "teletype"

A pty is a pseudotty, a device entry that acts like a terminal to the process reading and writing there,

but is managed by something else.

They first appeared for X Window and screen and the like,

where you needed something that acted like a terminal but could be used from another program.




## Quickstart

Start a PTY and set window size.

- Note: -cmd receives an array, and the parameters of the command are passed in the form of an array and needs to be serialized, such as：`[\"java\",\"-jar\",\"ser.jar\",\"nogui\"]`

```bash

go build

./pty -dir "." -cmd [\"bash\"] -size 50,50

```

You can execute any command, just like the SSH terminal.

```

ping google.com

top

htop

```




## Flags:

```

  -cmd string

        command

  -coder string

        Coder (default "UTF-8")

  -dir string

        command work path (default ".")

  -size string

        Initialize pty size, stdin will be forwarded directly (default "50,50")

```




## MCSManager

MCSManager is a Distributed, Docker-supported, Multilingual, and Lightweight control panel for Minecraft server and all console programs.

This application will provide PTY functionality for MCSManager,

it is specifically designed for MCSManager,

you can also try porting to your own application.

More info: [https://github.com/mcsmanager/mcsmanager](https://github.com/mcsmanager/mcsmanager)




## Contributing

Interested in getting involved?

- If you want to add a new feature, please create an issue first to describe the new feature, as well as the implementation approach. Once a proposal is accepted, create an implementation of the new features and submit it as a pull request.

- If you are just fixing bugs, you can simply submit PR.




## MIT license

Released under the [MIT License](https://opensource.org/licenses/MIT).

Copyright 2022 [zijiren233](https://github.com/zijiren233) and contributors.