📦 Helper CLI
A simple command-line tool to show system info (IP, CPU arch, etc.) and the commands used to get them.
🚀 Install
With uv (recommended):
uv tool install helper-cli
Or run without installing:
uvx --from helper-cli helper ip
With pip:
pip install helper-cli
🧠 Usage
helper [command]
Available commands:
| Command | Description | Example |
|---|---|---|
ip |
Show internal IP | helper ip |
pubip |
Show public IP | helper pubip |
arch |
Show CPU architecture (arm / amd) | helper arch |
si |
Show system information | helper si |
nix |
Show NixOS information | helper nix |
d |
Show Docker information | helper d |
sp |
Show speed test results | helper sp |
v |
Show virtual environment info | helper v |
f |
Show file information | helper f |
env |
Show environment variables | helper env |
run |
Run command snippets | helper run |
kill |
Kill processes by name or port | helper kill <name> |
disk |
Show disk usage, mount, and list info | helper disk usage |
journalctl |
Show useful journalctl options and examples | helper journalctl |
tools |
List other tools by the same author | helper tools |
odoo |
Download click-odoo scripts to current dir | helper odoo |
all |
Show all info | helper all |
Use -v for verbose output (e.g., helper ip -v).
Each command also prints the shell command it runs to get the result.
📚 Library Usage
You can import and use helper functions programmatically:
import helper
# Get disk usage information
usage = helper.disk.get_usage()
print(usage)
# Get system information as dict
info = helper.system_info.get_info()
print(f"System: {info['system']['system']}")
print(f"CPU: {info['cpu']['cpu']}")
# Get internal IP
ip = helper.internal_ip.get_internal_ip()
print(f"Internal IP: {ip}")
# Get public IP
pub_ip = helper.public_ip.get_public_ip()
print(f"Public IP: {pub_ip}")
# Get architecture
arch = helper.arch.get_arch()
print(f"Architecture: {arch}")
# Get all info
all_info = helper.all_info.get_info()
print(all_info)
🔄 Upgrade
With uv:
uv tool upgrade helper-cli
With pip:
pip install --upgrade helper-cli
🧑💻 Contribute
Pull requests are welcome!
Set up a development environment with uv:
uv venv
uv pip install -e ".[dev]"
Or with pip:
pip install -e ".[dev]"
Before submitting a PR, ensure your code passes lint checks and tests:
make lint
make test
With uv you can also run them directly:
uv run --extra dev ruff check .
uv run --extra dev pytest
Testing
Run the test suite:
make test
Or run pytest directly:
pytest
Tests are located in the tests/ directory. For detailed testing guidelines and conventions, see src_docs/testing.md.
1 maintainer
Metadata
1 maintainer
Release files for helper-cli 0.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| helper_cli-0.3.0.tar.gz | 39.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| helper_cli-0.3.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 90.1 kB
Release files / helper_cli-0.3.0.tar.gz
| Download URL | helper_cli-0.3.0.tar.gz |
|---|---|
| Size | 39.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
635832c1b9b7f481c375e77afaac413ac05ef5d43abcb46170a82e39261e0fb5
|
|
BLAKE2b-256 checksum How to use checksums |
af13db043d665bb8830d4f99cc3a0039534522b3273e8b204815ad0178fd0d08
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 31, 2026.
Transparency logRelease files / helper_cli-0.3.0-py3-none-any.whl
| Download URL | helper_cli-0.3.0-py3-none-any.whl |
|---|---|
| Size | 50.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ea797cffa89111b249ca5d7d6e57a6b33bcceffb25a180f0277552a061c64c0d
|
|
BLAKE2b-256 checksum How to use checksums |
b67af59113a195064d1fbf86a5823a72374d4b25b1abdade041d585e34cb0c68
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 31, 2026.
Transparency log
