netter 0.2.1

Netter is a CLI tool for fast and easy server startup!
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

# Netter


Netter is a CLI tool for quickly and easily launching servers.

## Table of Contents


* [Features](#features)
* [Functional](#functional)
* [Documentation](#documentation)
* [Installation](#installation)

## Features


* Support for complex server structures and routing;
* Support for different types of servers: HTTP, gRPC, TCP/UDP sockets;
* Support for SSL/TLS.

## Functional


* Creating a server on web sockets (websockets);
* 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
```