Metadata-Version: 2.2
Name: cli-aliases
Version: 0.0.1
Summary: `cli-aliases` implements command line aliases using the Click package.
Author-email: Jeff Wang <jkwang@usc.edu>
License: MIT License
Project-URL: Source, https://github.com/jeffkwang/cli-aliases
Project-URL: Tip Me, https://buymeacoffee.com/jeffkwang
Keywords: cli,Click
Classifier: Programming Language :: Python :: 3.13
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier:  Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: Click

# cli-aliases
cli-aliases is a simple implemention to set aliases for your Click CLI. 

# Installation
## Dependencies
- Click (>=8.1.8)

Install the package by entering `pip install cli-aliases` in your terminal.

# Usage: a simple example
```
import click
from cmd_aliases import AliasedGroup, AliasConfig

AliasConfig.add_alias("helloworld", "welcome")  # set a single alias entry in the form '(command, alias)'


@click.command(cls=AliasedGroup) # make sure to use the class, not an instance of it
def cli():
    pass


@cli.command()
def HelloWorld():
    click.echo("Hello World!")


if __name__ == "__main__":
    cli()
```

# TODO
- Add multiple alias comprehension
