About • Installation • Roadmap • FAQ
FreeFox CLI is a Python based CLI tool to manage FreeboxOS, the system running on ISP Routers provided by Free SAS.
- Python 3.8+
uvpackage manager
# Clone the repository
git clone https://github.com/EvieFloof/ffox
# Navigate to the project directory
cd ffox
# Sync dependencies
uv sync
# Install Freefox
uv tool install .
# Run the cli
ffox session test
- Good-looking CLI interface
- Login and create token to access the Freebox
AirMedia
- Air Media API
Call / Contaxts
- Call API
- Voicemail API
- Contacts API
Configuration
- Connection API
- LAN Config API
- Lan Browser API
- Wake On LAN API
- FreePlug API
- DHCP
- DHCP Configuration API
- DHCP Static Lease API
- DHCPv6 Configuration API
- FTP Config API
- TFTP Config API
- DMZ Config API
- Port Forwarding API
- Incoming Port API
- UPnP IGD
- UPnP IGD Config API
- UPnP IGD Redirection API
- LCD Config API
- LedStrip API
- Network Share
- Samba Config API
- AFP Config API
- UPnP AV Config API
- Switch API
- WiFi
- WiFi Global Config API
- WiFi Global State API
- WiFi AP API
- WiFi BSS API
- WiFi Radar API
- WiFi Planning API
- WiFi MAC Filter API
- WiFi Config Reset API
- WiFi Diagnistic API
- WiFi WPS API
- WiFi Guest API
- WiFi Temporary Disable API
- WiFi MLO API
- System API
- VPN Server API
- VPN Server Config API
- VPN Server User API
- VPN Server Connection API
- VPN User Configuration File API
- Slowness API
- Downloads API
- Download Stats API
- Download Files API
- Download Trackers API
- Download Peers API
- Download Pieces API
- Download Blacklist API
- Donwload Feeds API
- Download Configuration API
- File System API
- File Sharing Link API
- File Upload API
- WebSocket File Upload API
- Upload Progress Tracking API
- Home
- Home API
- Cameras API
- Language API
- Notification API
- Parental Filter
- Profiles API
- Network Control API
- Rule API
- Player API
- PVR
- PVR Config API
- PVR Quota API
- PVR Precord API
- PVR Frecord API
- Storage Media API
- RRD
- Standby API
- Storage
- Storage Disk API
- Storage Partition API
- Storage Config API
- RAID API
- SFP API
- Update API
- Virtual Machine API
What's the current state of `ffox` ?
Currently in a very barebone phase! Basic things works but that's it.Why did you create this ?
I really enjoy Free SAS products, and I like CLIs :DCan I contribute to the project ?
Of course you can, just open a pull requestWhat platforms does it support ?
Built with Python, `ffox` is Cross-PlatformIs it free ?
Absolutely! `ffox` is and always will be **free and open source**.Why "FreeFox"
Cause I reeeally like foxes :3We’d love to hear from you! Whether you found a bug, have an idea, or just want to say hi:
- 📧 Email: contactme@cutefox.dev
- 🐛 Report bugs: GitHub Issues
- ⭐ Like the project? Give it a star on GitHub!
- 🕹️ Thanks to Free SAS for the Freebox Delta
- ❤️ Special thanks to our testers and early supporters
Made with ❤️ and lots of API Calls