catsctl CLI
catsctl is the command-line interface for managing Catsplash.
General usage
Section titled “General usage”sudo catsctl [options] <command> [arguments]Options
Section titled “Options”| Option | Description |
|---|---|
--config <path> |
Path to the TOML configuration file |
Commands
Section titled “Commands”status
Section titled “status”Shows system statistics: interfaces, port, active/pending sessions, and total traffic.
sudo catsctl statusLists all clients in the database with their state, MAC, IP, connection time, data used, limits, and bandwidth.
sudo catsctl listManually authorizes a client.
sudo catsctl auth <mac> <ip>Example:
sudo catsctl auth aa:bb:cc:dd:ee:ff 192.168.10.50Manually disconnects a client.
sudo catsctl kick <mac>Example:
sudo catsctl kick aa:bb:cc:dd:ee:ffextend
Section titled “extend”Extends a client’s session by N minutes.
sudo catsctl extend <mac> <minutes>Example:
sudo catsctl extend aa:bb:cc:dd:ee:ff 30Sets a data limit for a client in MB. Use 0 to remove the limit.
sudo catsctl limit <mac> <mb>Example:
sudo catsctl limit aa:bb:cc:dd:ee:ff 500Sets bandwidth limits for a client.
sudo catsctl band <mac> <download> <upload>Values can be in mbit, kbit, etc. Use 0 to disable.
Example:
sudo catsctl band aa:bb:cc:dd:ee:ff 5mbit 2mbit