firetail
| Crates.io | firetail |
| lib.rs | firetail |
| version | 0.1.0 |
| created_at | 2025-02-04 21:42:33.925347+00 |
| updated_at | 2025-02-04 21:42:33.925347+00 |
| description | firetail is a tui tool designed to filter and view your Opnsense firewall logs with ease, It's still in development, but it already offers key features for efficient log analysis. |
| homepage | |
| repository | https://github.com/vivi202/firetail |
| max_upload_size | |
| id | 1542868 |
| size | 2,455,893 |
Vincenzo Marturano (vivi202)
documentation
README
About
firetail is a tui tool designed to filter and view your Opnsense firewall logs with ease, It's still in development, but it already offers key features for efficient log analysis.
Key features include:
- Interactive viewing: Use simple keybindings for efficient navigation.
- Real-time log viewing: Optionally view logs directly from the firewall.
With firetail, you can quickly parse and interact with firewall logs, ensuring you stay on top of your network security.
Demo
Prerequisites
- A linux based OS.
- Nerd Fonts (optional, but recommended for proper icon rendering)
Quickstart
You can install firetail with cargo:
cargo install firetail
Usage
firetail [OPTIONS] [LOGFILE]
Use --help to print the help message.
Note
if LOGFILE is not provided firetail will get logs from stdin
Examples
firetail -i vlan0.20 filter_20250102.log
Show logs filtered by the vlan0.20 interface.
firetail -i vlan0.20,vlan0.10 -d 192.168.40.10 filter_20250102.log
Show logs filtered by the vlan0.20 and vlan0.10 interfaces, and the destination IP 192.168.40.10.
TIP
Use this command to get logs directly from the firewall
nohup ssh yourfirewall opnsense-log -f filter >/dev/null 2>&1 | firetail
:keyboard: Keybindings
| Key | Action |
|---|---|
q |
Quit |
Up / k |
Scroll up |
Down / j |
Scroll down |
End |
Scroll to end |
. |
Enable auto-scroll |
i |
Toggle log info popup |
d |
Start date search (switches to edit mode) |
Enter (in edit mode) |
Confirm edit and return to normal mode |
Esc (in edit mode) |
Cancel edit and return to normal mode |
Contributing
Contributions are very welcome and appreciated! Feel free to open an issue, submit a pull request, or suggest improvements. :rocket:
Support
If you like what I'm working on and want to support me, you can buy me a coffee! ☕ It helps me stay energized and motivated to keep improving firetail. Every cup is appreciated! 🙏