Skip to content

thiagomeloo/myalias

Repository files navigation

My Alias

Alias management help tool for terminal.

Install

  pip install myalias

Update

  pip install myalias --upgrade

Setup

  myalias setup

  # if the path is not defined add the following line to the configuration file
  export PATH="$HOME/.local/bin:$PATH"

Help

  myalias --help

  #return: 

  Usage: myalias [OPTIONS] COMMAND [ARGS]...                                          
                                                                                      
  ╭─ Options ─────────────────────────────────────────────────────────────────────────╮
  │ --version  -v        Show the version and exit.                                   │
  │ --help               Show this message and exit.                                  │
  ╰───────────────────────────────────────────────────────────────────────────────────╯
  ╭─ Commands ────────────────────────────────────────────────────────────────────────╮
  │ add-alias       Add alias to the application. Args:     name (str): Name of       │
  │                 command.     description (str): Description of command.           │
  │                 command (str): Command to execute.                                │
  │ import-aliases  Import list aliases to the application. Args:     file_path       │
  │                 (str): Path to aliases list file.                                 │
  │ list-alias      List alias to the application.                                    │
  │ remove-alias    Remove alias to the application. Args:     name (str): Name of    │
  │                 command.                                                          │
  ╰───────────────────────────────────────────────────────────────────────────────────╯
  ╭─ Help and Others ─────────────────────────────────────────────────────────────────╮
  │ about      Display information about the application.                             │
  │ setup      Setup initial to configure application.                                │
  ╰───────────────────────────────────────────────────────────────────────────────────╯

Add

  myalias add-alias "ll" "description" "ls -la"

  #return:
  Alias created successfully

Import

  myalias import-aliases ./echoAliases

  #return:
  Adding alias ec
  Alias created successfully

Remove

  myalias remove-alias "ll" "description" "ls -la"

  # return:
  Alias removed successfully

List

  myalias list-alias

  # return:
  ┏━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━┓
  ┃ Name ┃ Description ┃ Command ┃
  ┡━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━┩
  │ ll   │ description │ ls -la  │
  └──────┴─────────────┴─────────┘

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages