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.2.0.tar.gz (16.3 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.2.0-py3-none-any.whl (18.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for babicli-0.2.0.tar.gz
Algorithm Hash digest
SHA256 a38f843e49adaa687ab57bfe7ce7bb4a1f65af7043a874697a50d4e0c2a3649b
MD5 f61ffe2abb644948ba4959a2f7e93d6d
BLAKE2b-256 f4abd139c6a06f8ac9c27bb57fb509adc9ebc4b11f9923cc3457c52755b13650

See more details on using hashes here.

File details

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

File metadata

  • Download URL: babicli-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 18.6 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.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2aabf8539718545aa75ba2c2cb5647d7df871b6063b6fb56b11ae7d48977d4c3
MD5 f1025e38ce30b825d29bca5b2e8444db
BLAKE2b-256 399d32d629c1d225ea0f4fcdafe091a6c06e41e344ff8e34d1cb6264cdd9bf10

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