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/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:

pip3 install -U --user topalias

From source:

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

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 usage statistic
  • add any acronym algorithm
  • more statistics & analytics (used dir, utils, parameters, time)
  • only util in command without parameters usage statistic
  • history file path parameter
  • top command count parameter
  • alias max length parameter

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.11.tar.gz (14.0 kB view details)

Uploaded Source

Built Distribution

topalias-1.2.11-py3-none-any.whl (13.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: topalias-1.2.11.tar.gz
  • Upload date:
  • Size: 14.0 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.11.tar.gz
Algorithm Hash digest
SHA256 c86950393e993406460cdc1563ec2278b68111ab0a5ece6a615b96416d51c875
MD5 a4e04ca02d304260e9430dffc6c5249b
BLAKE2b-256 7250756a8282fca2d052c8b6f83ca3a92e0eb5e1e02d6aa97a7996f8aea439c2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: topalias-1.2.11-py3-none-any.whl
  • Upload date:
  • Size: 13.6 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.11-py3-none-any.whl
Algorithm Hash digest
SHA256 b64c66a3b0f47537f780fb5d9b514b62a415d6ab4169d8e58fe4377919634190
MD5 bff79a03e4194bdbc0ef1b3dc819ae7e
BLAKE2b-256 e1c584cd6fb0b4fe12e8bef666dd10df70350d25272e875e9da849e98e548b4d

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