Installation

Language: English · Português (pt-BR)

Requirements

• Python 3.8–3.12 (Python 3.13+ not supported due to telnetlib removal)
• OS: Windows 10/11, Linux (Debian/Ubuntu/Kali/Arch), macOS 12+
• Disk: ~50 MB (project + venv)
• RAM: ~80 MB in operation

---

Standard Installation

git clone https://github.com/mrhenrike/MikrotikAPI-BF.git
cd MikrotikAPI-BF

# Create virtual environment (strongly recommended)
python -m venv .venv

# Activate
.venv\Scripts\activate        # Windows PowerShell
source .venv/bin/activate     # Linux / macOS

# Install dependencies
pip install -r requirements.txt

# Verify
python mikrotikapi-bf.py --version
# → mikrotikapi-bf Version 3.10.0

---

Dependencies

Package	Used for
requests	HTTP API calls, EWS detection
colorama	Colored terminal output
paramiko	SSH post-login validation
PySocks	SOCKS5/HTTP proxy support
PyYAML	Config file parsing
routeros-api	RouterOS binary API protocol

---

Install on Kali Linux

sudo apt update && sudo apt install -y python3 python3-venv python3-pip git
git clone https://github.com/mrhenrike/MikrotikAPI-BF.git
cd MikrotikAPI-BF
python3 -m venv .venv && source .venv/bin/activate
pip install -r requirements.txt
python mikrotikapi-bf.py --version

---

Python Version Compatibility

Python	Status
3.8–3.12	Fully supported
3.13+	Not supported — telnetlib removed
3.7 and below	Not supported

If you have Python 3.13+:

# Linux — install 3.12 alongside 3.13
sudo apt install python3.12
python3.12 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

---

Troubleshooting

Error	Cause	Fix
ModuleNotFoundError: socks	PySocks missing	pip install PySocks
ModuleNotFoundError: yaml	PyYAML missing	pip install PyYAML
telnetlib error	Python 3.13+	Use Python 3.12
Permission denied on results/	Wrong dir	Use --export-dir /tmp/results

---

pip Install (recommended)

pip install mikrotikapi-bf
mikrotikapi-bf --version
# → mikrotikapi-bf 3.10.0

---

See also: Quick Start · Features