Metadata-Version: 2.5
Name: akctl
Version: 0.1.0
Summary: A simple CLI toolkit for everyday server management tasks
Project-URL: Homepage, https://github.com/AmirKenzo/ak-cli
Project-URL: Repository, https://github.com/AmirKenzo/ak-cli
Project-URL: Issues, https://github.com/AmirKenzo/ak-cli/issues
Author: AmirKenzo
License-Expression: MIT
License-File: LICENSE
Keywords: backup,cli,monitoring,server,sysadmin,telegram
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: System :: Systems Administration
Classifier: Topic :: Utilities
Requires-Python: <3.15,>=3.10
Requires-Dist: psutil>=5.9
Requires-Dist: rich>=13.0
Description-Content-Type: text/markdown

# 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

| Command         | Description                                   |
| --------------- | ---------------------------------------------- |
| `system-info`   | OS, architecture, Python version, hostname     |
| `disk-usage`    | Usage for every mounted disk/partition         |
| `network-info`  | IPv4 address of every network interface        |
| `memory-info`   | RAM and swap usage                             |
| `cpu-info`      | Core count, current usage, frequency           |
| `process-list`  | Top processes by memory usage                  |
| `uptime`        | System boot time and uptime                    |
| `users`         | Currently logged-in users                      |
| `port-check`    | Check whether a TCP port on a host is open     |

## Requirements

- Python 3.10+

## Installation

Clone the repo and install it in a virtual environment. [uv](https://docs.astral.sh/uv/)
is recommended:

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

Or with plain `pip`:

```bash
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:

```bash
ak
```

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

```bash
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
```

## Roadmap

- Folder backups with scheduled/on-demand runs
- Sending backup archives straight to a Telegram chat (via Telethon or
  Pyrogram), delivered to a numeric chat ID you configure

## License

MIT — see [LICENSE](LICENSE).
