ak-cli

A small CLI I built for my own server management needs — quick answers to "what's using the RAM", "is this port open", "how full is the disk", without reaching for a full monitoring stack. Sharing it in case it's useful to someone else too.

Every command works both as a direct CLI call and from an interactive menu, so you can script it or just run ak and pick from a list.

Features

Requirements

• Python 3.10+

Installation

Clone the repo and install it in a virtual environment. uv is recommended:

git clone https://github.com/AmirKenzo/ak-cli.git
cd ak-cli
uv sync
uv run ak

Or with plain pip:

git clone https://github.com/AmirKenzo/ak-cli.git
cd ak-cli
python -m venv .venv
.venv/Scripts/activate   # on Linux/macOS: source .venv/bin/activate
pip install -e .
ak

Usage

Running ak with no arguments opens the interactive menu:

ak

Every command is also available directly, which is handy for scripts and one-liners:

ak system-info
ak disk-usage
ak memory-info
ak cpu-info
ak process-list --limit 5
ak port-check example.com 443
ak uptime
ak users

Backups

ak backup archives a configured list of folders (defaults to /opt/pasarguard and /var/lib/pasarguard, e.g. for a Pasarguard panel) into a .tar.gz and sends it to a Telegram chat via Telethon.

ak backup-init   # interactive wizard: prompts for paths + telegram, saves to ~/.config/ak/backup.json
ak backup            # archive configured paths and send to Telegram
ak backup --keep     # also save the archive in the current directory

If you skip backup-init and just run ak backup in a terminal, it prompts you for the Telegram bot token/chat ID on the spot (and offers to save them) instead of failing. api_id/api_hash default to Telegram Desktop's public API credentials if left unset, so only bot_token and chat_id are needed.

Config can also be provided entirely via environment variables — useful for cron/systemd, where there's no terminal to prompt on: AK_BACKUP_PATHS (comma-separated), AK_TG_API_ID, AK_TG_API_HASH, AK_TG_BOT_TOKEN, AK_TG_CHAT_ID, and AK_BACKUP_CONFIG to point at a non-default config file location.

Roadmap

• Scheduled (cron) backup runs
• Including database dumps alongside the folder backups

License

MIT — see LICENSE.