https://github.com/bjfssd757/netter
Netter is a CLI tool for quickly and easily launching servers.
https://github.com/bjfssd757/netter
collaborate communityexchange github github-copilot
Last synced: 6 months ago
JSON representation
Netter is a CLI tool for quickly and easily launching servers.
- Host: GitHub
- URL: https://github.com/bjfssd757/netter
- Owner: bjfssd757
- License: mit
- Created: 2025-04-10T15:39:21.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-04-23T20:17:55.000Z (6 months ago)
- Last Synced: 2025-04-24T01:13:01.524Z (6 months ago)
- Topics: collaborate, communityexchange, github, github-copilot
- Language: Rust
- Homepage:
- Size: 29.2 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Netter
Netter is a CLI tool for quickly and easily launching servers.
## Table of Contents
* [Future](#future)
* [Features](#features)
* [Documentation](#documentation)
* [Installation](#installation)
* [Dependencies](#dependencies)
* [Commands](#commands)
## Future
* Support for complex server structures and routing;
* Support for different types of servers: gRPC, TCP/UDP sockets;
* Support for SSL/TLS.
## Features
* Creating a server on web sockets (websockets);
* Creating HTTP server;
* Stopping any server launched via netter.
## Documentation
Launching a server is done using the command:
```powershell
netter start
```
Stopping a server is done using the command:
```powershell
netter stop
```
### Start
The start command accepts the following parameters:
* **--type**: server type: **websocket**, **tcp**, **udp**, **http**, **grpc**:
```powershell
netter start --websocket
```
* **--host**: server address:
```powershell
netter start --websocket --host 127.0.0.1
```
* **--port**: server port:
```powershell
netter start --websocket --host 127.0.0.1 --port 808
```
* **--protect**: whether to protect or not (default is no. If the flag is absent, it is also no):
```powershell
netter start --websocket --host 127.0.0.1 --port 8080 --protect
```
For the type parameter and server protection status, you do not need to specify anything other than the flag itself.
### Stop
The stop command will stop any running server:
```powershell
netter stop
```
#### How does it work?
> [!NOTE]
> When starting a server (netter start), a server state file is created, which specifies the host, **pid**, port, and protection status. This file helps maintain the existence of a running server and manage it during the process, as each new command you use = code execution from scratch. The running server will continue to work because it is built on asynchronous operations.\
> The presence of the pid parameter in the state file helps terminate the server. It indicates the process ID of the server in the system. After using the stop command, netter "kills" the process (stops it).
## Installation
In case of errors or questions about installing Rust, you can refer to the documentation in the [Rust book](https://rust-lang.github.io/book/ch01-01-installation.html).
### Windows
* To install Rust on Windows, you need to go to [this link](https://www.rust-lang.org/tools/install) and download the language from there.
* Then you need to install netter:
```bash
cargo install netter
```
### Linux
* Install Rust:
```bash
curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf | sh
```
* Install netter:
```bash
cargo install netter
```
## Dependencies
Netter uses the following key libraries:
* [tokio](https://tokio.rs/): An asynchronous runtime for Rust.
* [hyper](https://hyper.rs/): An HTTP library for Rust.
## Commands
### Start
This command will start the server.
Use:
``` powershell
netter start --http --host 127.0.0.1 --port 8080 --path routes.yaml
```
**Flags**:
* **--http**: will start the server in HTTP mode;
* **--websocket**: will start the server in websocket mode;
* **--grpc**: will start the server in gRPC mode;
* **--tcp**: will start the server in TCP mode;
* **--udp**: will start the server in UDP mode;
* **--host**: specifies the host for the server;
* **--port**: specifies the port for the server:
* **--path**: will specify the path to the configuration file for the server;
* **--protect**: whether to use ssl/tls for the server. True or False;
### Stop
This command will stop the server.
Use:
``` powershell
netter stop
```