Skip to main content

A simple extendable CLI tool.

Project description

============================================================ BABICLI NOTES / DOCUMENTATION


Project: babicli Description: A fast and extendable command-line tool with a plugin architecture. All functionality lives inside plugins.

============================================================ INSTALLATION (pip)

Install locally: pip install .

Update: pip install --upgrade babicli

Run: babicli help

========================================================= AVAILABLE COMMANDS (plugins)

bench – Run CPU and disk benchmarks cache clear – Delete all cache files cache show – Show the cache directory cache size – Display the total cache size diskguard – Detect disk usage issues and warn when space is low doctor – Diagnose system problems (DNS, network, pip) help – Show all available commands mgenerate – Automatically generate a new plugin modules – List all loaded plugins netinfo – Show local and public IP address information ranum – Generate a chaotic 32-digit random number sysinfo – Display OS, CPU, RAM, and storage information

========================================================= HOW TO CREATE NEW PLUGINS

Option 1: Manually

Create new file in: babicli/src/babicli/plugins/myplugin.py

Add:

def run():
     print("My plugin works!")

Then run: babicli myplugin

Option 2: Automatically (recommended)

babicli mgenerate myplugin

This will generate: plugins/myplugin.py

With a template that looks like:

def run():
     print("Plugin myplugin loaded successfully!")

=========================================================

TROUBLESHOOTING

  1. babicli: command not found → reinstall: pip install .

  2. Plugin not found: → ensure file is located in: src/babicli/plugins/NAME.py

    → ensure file name contains only lowercase letters + digits

  3. Updated code not working after pip install: → remove old builds: rm -rf dist build .egg-info (PowerShell equivalent:) Remove-Item -Recurse -Force dist Remove-Item -Recurse -Force build Get-ChildItem -Filter ".egg-info" | Remove-Item -Recurse -Force

    → rebuild: python -m build

    → upload: twine upload dist/*

  4. Plugins not detected → check plugins/init.py exists → check for uppercase letters in filenames → print loaded plugins:

    python - << 'EOF' import pkgutil, babicli.plugins print([m.name for m in pkgutil.iter_modules(babicli.plugins.path)]) EOF

========================================================= NOTES FOR FUTURE DEVELOPMENT

Ideas for future plugins:

  • memwatch – detect RAM leaks
  • powercheck – detect undervoltage on Raspberry Pi
  • sdhealth – detect SD card corruption
  • netdoctor – deep network diagnostics
  • bootcheck – detect boot-level problems
  • aptfix – fix package manager locks
  • logguard – detect log file explosion (100GB logs)
  • zombies – detect zombie processes
  • sshwatch – detect brute-force attempts (safe)

============================================================

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

babicli-0.1.8.tar.gz (16.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

babicli-0.1.8-py3-none-any.whl (18.7 kB view details)

Uploaded Python 3

File details

Details for the file babicli-0.1.8.tar.gz.

File metadata

  • Download URL: babicli-0.1.8.tar.gz
  • Upload date:
  • Size: 16.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for babicli-0.1.8.tar.gz
Algorithm Hash digest
SHA256 1f9c82d73315653298d11272cd10e21a66f3a2960941ac577b1c729c3d3f4c03
MD5 35ec22d7ddaf4a0ea15e22806c2dd08d
BLAKE2b-256 90d255a82ff1212fdfb85280e3324c8c2d0e3fba7555caf3bf2373fe11f2d4de

See more details on using hashes here.

File details

Details for the file babicli-0.1.8-py3-none-any.whl.

File metadata

  • Download URL: babicli-0.1.8-py3-none-any.whl
  • Upload date:
  • Size: 18.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for babicli-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 67c656848d9aa6c4ee5242e794ca37af2624718d6703302cf06d9e1f51725f85
MD5 315d098393e8cdf07e3f4d1d45c584c2
BLAKE2b-256 872d07d6fd53c4c2dd478f05ec2a355d192746fba5982665bc6eb53757afed02

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page