Skip to main content

Linux bash alias generator

Project description

topalias

Build Status Coverage GitLab pipeline Python Version

topalias - Linux bash/zsh alias generator and statistics from command history, written on Python.

Features

  • Generate short alias for popular command from bash history
  • Fully typed with annotations and checked with mypy, PEP561 compatible

Installation

From pypi.org repository:

pip3 install -U --user topalias

From source:

git clone https://github.com/CSRedRat/topalias
python3 topalias/setup.py install

Run as python script without install:

git clone https://github.com/CSRedRat/topalias
python3 topalias/topalias/cli.py -h

Install requirements

sudo apt install python3 python3-pip -y

Usage

generated bash aliases

Showcase how your project can be used:

topalias # check if you uses aliases in ~/.bash_aliases - analyze and print usage statistics, offers to find new simple aliases
topalias -h # print help
topalias history # analyze local bash history
topalias h --acr=2 # set minimal length for generated acronym filter, so that exclude some short command and find long, hard, usable command

File path search order:

  • .bash_history in current . directory
  • .bash_history in home ~ directory
  • example development files in topalias/data

Run as python module:

python3 -m topalias

Also you can use topalias utility in Bash for Git on Windows and in WSL.

TODO

  • zsh support
  • exclude used alias from command chart
  • alias use statistic
  • only util in command without parameters usage statistic
  • history file path parameter
  • top command count parameter
  • alias max length parameter
  • snap package
  • flatpak package

Please add you feature requests: https://github.com/CSRedRat/topalias/issues/new

License

GPLv3

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Sergey Chudakov

💻 🚇 🤔 🚧 📦 🧑‍🏫 💡

GitLab repository mirror with CI/CD: https://gitlab.com/CSRedRat/topalias GitHub Pages: https://csredrat.github.io/topalias/

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

topalias-1.2.7.tar.gz (13.5 kB view details)

Uploaded Source

Built Distribution

topalias-1.2.7-py3-none-any.whl (13.4 kB view details)

Uploaded Python 3

File details

Details for the file topalias-1.2.7.tar.gz.

File metadata

  • Download URL: topalias-1.2.7.tar.gz
  • Upload date:
  • Size: 13.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.6

File hashes

Hashes for topalias-1.2.7.tar.gz
Algorithm Hash digest
SHA256 4bf5fddc41bf26e0a65de2ebdd998cfd72f0b471be8976a8105e7e19d04ed239
MD5 c828b5050469cf8d8ae2f6504aa0aee2
BLAKE2b-256 78f34d9324e6bf8b936826e4e67b4abab13aa28a07370ce208babea87806bda2

See more details on using hashes here.

File details

Details for the file topalias-1.2.7-py3-none-any.whl.

File metadata

  • Download URL: topalias-1.2.7-py3-none-any.whl
  • Upload date:
  • Size: 13.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.6

File hashes

Hashes for topalias-1.2.7-py3-none-any.whl
Algorithm Hash digest
SHA256 8b995714eec66c319366d42878992b9143e3af0ae885f2406db041a32971cf39
MD5 5f2c417ce77ae37cc149ee82aa3eaf4a
BLAKE2b-256 c4a02c6f425777651e2d7d55228d893fa56b2aebe8a3cee832dfe3baa8ea9e74

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page