Skip to content

MouxiaoHuang/cli-commands

Repository files navigation

cli-commands

GitHub repo CI PyPI License GitHub stars

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

Package Names

  • GitHub repo: cli-commands
  • PyPI package: cli-commands-kit (install with pip install cli-commands-kit)
  • Legacy package: linux-command (older name; still installable but no longer updated via pip install linux-command with cmd entrypoint)

Why cli-commands

Terminal 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, cli 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 cli <command> [args...] or cmd <command> [args...].

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

Quick examples:

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

Before vs cli-commands:

tar -czvf out.tar.gz ./src        ->  cli tar ./src out.tar.gz
tar -xzvf archive.tar.gz -C ./out ->  cli untar archive.tar.gz ./out
ps aux | grep python              ->  cli 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.

About

A single entrypoint for common terminal tasks. It keeps commands short, consistent, and easy to remember.

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages