Skip to main content

A unified CLI wrapper for common terminal commands.

Project description

cli-commands

CI PyPI GitHub stars

cli-commands provides a single entrypoint for common terminal tasks. It keeps commands short, consistent, and easy to remember.

Why cli-commands

Linux commands are powerful but easy to forget, especially for archives and process checks. cli-commands lowers the mental load with a unified syntax that reads like the task itself. For example, cmd tar <source> <output.tar> means “pack <source> into <output.tar>,” no long flags to recall.

Installation

To install the package, run the following command:

pip install cli-commands-kit

Install From Source (Development)

If you want to develop or modify the tool locally:

git clone https://github.com/MouxiaoHuang/cli-commands.git
cd cli-commands
pip install -e .

Usage

Once installed, run commands with cmd <command> [args...] or cli <command> [args...].

  • cmd -h / cmd --help lists all available commands.
  • cmd <command> -h shows usage and examples for a specific command.
  • cli behaves the same as cmd (alternate entrypoint).

Quick examples:

cmd tar ./src out.tar.gz
cmd untar archive.tar.gz ./out
cmd ps-grep python

Before vs cmd:

tar -czvf out.tar.gz ./src        ->  cmd tar ./src out.tar.gz
tar -xzvf archive.tar.gz -C ./out ->  cmd untar archive.tar.gz ./out
ps aux | grep python              ->  cmd ps-grep python

Full command list, examples, and aliases live in USAGE.md.

Contributing

We welcome contributions from the community! If you'd like to help improve cli-commands, feel free to report issues or submit pull requests.

Guidelines for Contributors

  • Follow the existing coding style where possible.
  • Make sure your changes do not break existing functionality.
  • Before submitting a major feature, it’s often a good idea to first discuss it by opening an issue.

Thank you!

Thank you for your interest in contributing to cli-commands! Your contributions are greatly appreciated and help make this tool better for everyone. For any questions or to get started, feel free to reach out or open an issue.


License

This project is licensed under the MIT License.

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

cli_commands_kit-1.0.0.tar.gz (13.6 kB view details)

Uploaded Source

Built Distribution

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

cli_commands_kit-1.0.0-py3-none-any.whl (11.3 kB view details)

Uploaded Python 3

File details

Details for the file cli_commands_kit-1.0.0.tar.gz.

File metadata

  • Download URL: cli_commands_kit-1.0.0.tar.gz
  • Upload date:
  • Size: 13.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.12

File hashes

Hashes for cli_commands_kit-1.0.0.tar.gz
Algorithm Hash digest
SHA256 60a7c07950f6910ed517a9a3bca7014d26e798365214c523c3d9678f035b045d
MD5 744ef40ba92c456dc82eb4b16a0ca819
BLAKE2b-256 faf683b9122d2cc79979328e9b0121e8a90b0815081ba0d511025788d729c5f1

See more details on using hashes here.

File details

Details for the file cli_commands_kit-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for cli_commands_kit-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b9f2b687adcb1c4bb441ea4a8f67f7acfd2ea25996a499f47b8c68c2cf669740
MD5 1e0ca052c54d84032a9fc4f213906a27
BLAKE2b-256 ef5a246f295583245a1025f9e08fa959832c54693391be6e10b47eaf1d8088ab

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