Metadata-Version: 2.1
Name: alias-windows
Version: 1.1.1
Summary: Manage command aliases in Windows
Home-page: https://github.com/alexesprit/alias
Author: alexesprit
License: MIT
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Microsoft :: Windows
Requires-Python: >=3.6
Description-Content-Type: text/markdown

# alias ![Version][PyPIBadge] ![Test status][WorkflowBadge]

Manage command aliases in Windows.

## Installation

```sh
> pip install alias-windows
```

By default aliases are stored in `%USERPROFILE%\Documents\Scripts\Aliases`. You can set the directory to store aliases by changing the environment variable called `%ALIASES_DIR%`.

## Managing aliases

Get the list of available aliases:
```cmd
> alias
apktool, gsh, gst
> alias -v
apktool = %SOFTWARE%\apktool\apktool.bat %*
gsh = git show $*
gst = git status --short --branch %*
```
Add an alias:
```cmd
> alias test=dir \b %*
Added test
```
Show the alias:
```cmd
> alias g
gsh, gst
> alias test
dir \b %*
```
Search for a text in alias commands:
```cmd
> alias -s apk
baksmali, smali
> alias -s apk -v
baksmali = %SOFTWARE%\apktool\apktool.bat d %*
smali = %SOFTWARE%\apktool\apktool.bat b %*
```
Delete the alias:
```cmd
> alias -d test
Deleted test
```

## Environment variables

`alias` changes two variables:
1. `%ALIASES_DIR%`
Directory where aliases are stored.
2. `%PATH%`
Adds `%ALIASES_DIR%` to `%PATH%`.

## License

This project is licensed under the [MIT License][License].

[License]: https://github.com/test-room-7/alias/blob/master/LICENSE.md
[PyPIBadge]: https://img.shields.io/pypi/v/alias-windows
[WorkflowBadge]: https://img.shields.io/github/workflow/status/alexesprit/alias/Test?label=Test


