docs: Add new docs and fix rule command
All checks were successful
CI.yml / build (push) Successful in 1m53s

This commit is contained in:
d3m0k1d
2026-01-15 18:06:48 +03:00
parent 14c6c64989
commit eaf276bd3f
3 changed files with 56 additions and 1 deletions

51
docs/cli.md Normal file
View File

@@ -0,0 +1,51 @@
# CLI commands BanForge
BanForge provides a command-line interface (CLI) to manage IP blocking,
configure detection rules, and control the daemon process.
## Commands
### init - create a deps file
```shell
banfogre init
```
**Description**
This command creates the necessary directories and base configuration files
required for the daemon to operate.
### daemon - Starts the BanForge daemon process
```shell
banforge daemon
```
**Description**
This command starts the BanForge daemon process in the background.
The daemon continuously monitors incoming requests, detects anomalies,
and applies firewall rules in real-time.
### firewall - Manages firewall rules
```shell
banforge ban <ip>
banforge unban <ip>
```
**Description**
These commands provide an abstraction over your firewall. If you want to simplify the interface to your firewall, you can use these commands.
### rule - Manages detection rules
```shell
banforge rule add -n rule.name -m 403
banforge rule list
```
**Description**
These command help you to create and manage detection rules in CLI interface.
| Flag | Required |
| ----------- | -------- |
| -n -name | + |
| -s -service | + |
| -p -path | - |
| -m -method | - |
| -c -status | - |
You must specify at least 1 of the optional flags to create a rule.

0
docs/config.md Normal file
View File