Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/meteoritt/topalias

Linux bash/zsh aliases generator
https://github.com/meteoritt/topalias

alias alias-analysis alias-loader alias-management aliases aliases-setup aliasing bash cli cmd command console history linux python shell terminal top zsh

Last synced: 3 months ago
JSON representation

Linux bash/zsh aliases generator

Host: GitHub
URL: https://github.com/meteoritt/topalias
Owner: meteoritt
License: gpl-3.0
Created: 2021-10-23T09:55:59.000Z (about 3 years ago)
Default Branch: master
Last Pushed: 2022-12-23T11:34:28.000Z (about 2 years ago)
Last Synced: 2024-10-29T11:42:10.507Z (3 months ago)
Topics: alias, alias-analysis, alias-loader, alias-management, aliases, aliases-setup, aliasing, bash, cli, cmd, command, console, history, linux, python, shell, terminal, top, zsh
Language: Python
Homepage: https://pypi.org/project/topalias
Size: 546 KB
Stars: 45
Watchers: 3
Forks: 4
Open Issues: 13
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

        # topalias

[![Test Status](https://github.com/CSRedRat/topalias/workflows/Test/badge.svg?branch=master)](https://github.com/CSRedRat/topalias/actions?query=workflow%3ATest)

[![Coverage](https://coveralls.io/repos/github/CSRedRat/topalias/badge.svg?branch=master)](https://coveralls.io/github/CSRedRat/topalias?branch=master)

[![GitLab pipeline](https://gitlab.com/CSRedRat/topalias/badges/master/pipeline.svg)](https://gitlab.com/CSRedRat/topalias/-/pipelines)

[![Python Version](https://img.shields.io/pypi/pyversions/topalias.svg)](https://pypi.org/project/topalias/)

[![Downloads](https://static.pepy.tech/personalized-badge/topalias?period=total&units=international_system&left_color=black&right_color=orange&left_text=Downloads)](https://pepy.tech/project/topalias)

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)

[![DeepSource](https://static.deepsource.io/deepsource-badge-light-mini.svg)](https://deepsource.io/gh/CSRedRat/topalias/?ref=repository-badge)

[topalias](https://github.com/CSRedRat/topalias) - Linux alias generator from bash/zsh command history with statistics, written on [Python](https://pypi.org/project/topalias/).

## Features

-   Generate short alias for popular command from bash/zsh shell history

-   Command history statistics & analytics

-   Parametrised input

-   Console help for all commands, options and arguments

-   Shell workflow hints

## Installation

From [pypi.org repository](https://pypi.org/project/topalias/):

```bash

pip3 install -U --user topalias

```

From source:

```bash

git clone https://github.com/CSRedRat/topalias

python3 topalias/setup.py install --user

```

Run as python script without install:

```bash

git clone https://github.com/CSRedRat/topalias

python3 topalias/topalias/cli.py -h

```

### Install requirements

```bash

sudo apt install python3 python3-pip -y

```

Add PATH environment variable for run Python tools as Linux utility:

```bash

echo "export PATH=$PATH:$HOME/.local/bin" >> ~/.bashrc

source ~/.bashrc

```

## Usage

![generated bash aliases](https://github.com/CSRedRat/topalias/raw/master/images/bash_screenshot.png "Bash topalias output")

Without parameters utility check if you use alias in ~/.bash_aliases - analyze and print usage statistics, then find new simple aliases

```bash

python3 -m topalias  # run as python module

topalias  # check aliases and print suggestion bash command history

topalias -h  # print help

topalias --zsh  # work with zsh shell command history

topalias --min=2  # set minimal length for generated acronym filter, so that exclude some short command and find long, hard, usable command

topalias --debug history  # only analyze local bash history and print filtered rows

```

Files path search order:

-   directory from execution parameter

-   .bash_history in . current directory

-   .bash_history in ~ user home directory

-   example development files in topalias/data

You can change dot files search path to another user home directory:

```bash

topalias -f /home/user  # or topalias --path /home/user

```

Also you can use topalias utility in [Bash for Git](https://gitforwindows.org) on Windows and in [WSL](https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux).

### Documentation

```

Usage: topalias [OPTIONS] COMMAND [ARGS]

Options:

  -l, --min INTEGER     Print alias acronym not less that value. Default: 1

  -c, --count INTEGER   Print specified number acronym suggestions. Default:

                        20

  --filter              Filter used aliases in history. Default: False

  -z, --zsh             Use zsh shell history file .zsh_history. Default:

                        False

  -f, --path TEXT       Change custom directory for files: .bash_aliases,

                        .bash_history, .zsh_history

  --version             Print current program version and check latest on

                        pypi.org.

  --debug / --no-debug  Enable debug strings in output.

  -h, --help            Show this message and exit.

Commands:

  hint     Print all hints.

  history  Print bash history file.

  version  Get program current and available version.

```

## TODO

-   check if alias name already used

-   check if alias already added

-   add any another acronym algorithm with semantic

-   more statistics & analytics (used dir, utils, parameters, time)

-   alias max length parameter

-   command ignore list flag: top, emacs, vim

-   often used command "ssh username@servername" suggest add to .ssh/config/

## License

[GPLv3](https://github.com/CSRedRat/topalias/blob/master/LICENSE)

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    
_{Sergey Chudakov}
💻 🚇 🤔 🚧 📦

    
_{Sergey Morozik}
💻

  

_GitLab repository mirror with CI/CD: [https://gitlab.com/CSRedRat/topalias](https://gitlab.com/CSRedRat/topalias)_