https://github.com/crgimenes/compterm
Versatile terminal sharing tool for educational, development, and nostalgic BBS experiences, optimized for Golang study groups and pair programming.
https://github.com/crgimenes/compterm
bbs golang terminal-sharing
Last synced: 5 months ago
JSON representation
Versatile terminal sharing tool for educational, development, and nostalgic BBS experiences, optimized for Golang study groups and pair programming.
- Host: GitHub
- URL: https://github.com/crgimenes/compterm
- Owner: crgimenes
- License: mit
- Created: 2023-11-18T14:22:28.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-11-17T23:04:20.000Z (5 months ago)
- Last Synced: 2024-11-18T00:20:11.345Z (5 months ago)
- Topics: bbs, golang, terminal-sharing
- Language: Go
- Homepage:
- Size: 4.09 MB
- Stars: 11
- Watchers: 3
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Overview
Compterm is a versatile terminal sharing application designed for a variety of use cases, including educational, developmental, and nostalgic experiences. It's particularly useful for the Brazilian Golang Study Group, the Atomic Blast BBS system, and for efficient, low-bandwidth pair programming sessions.
# Installation
To use Compterm, Go developers can build the program for production using:
```bash
make
```
For development mode, which uses resources from the assets directory, use:
```bash
make dev
```
In production mode, resources are integrated into the executable itself.
# Configuration
Compterm accepts the following command-line arguments:
- -c string: Command to run (default: $SHELL)
- -debug: Enable debug mode
- -listen string: Listen address (default "0.0.0.0:2200")
- -motd string: Message of the day
It also recognizes these environment variables:
- $COMPTERM_DEBUG bool (default "false")
- $COMPTERM_LISTEN string (default "0.0.0.0:2200")
- $COMPTERM_C string
- $COMPTERM_MOTD string (default "")
Additionally, you can configure Compterm using a init.lua file located in ~/.config/compterm/init.lua.
## Configuration Hierarchy
Command-line parameters override environment variables, and the lua in the init.lua can override both variables and commands.
# Contributing
Contributions are welcome! Please refer to our contribution guidelines for details on how to contribute to this project.
# License
This project is licensed under MIT, see the [LICENSE](LICENSE) file for details.