prtl

Crates.ioprtl
lib.rsprtl
version0.3.0
sourcesrc
created_at2023-02-01 22:50:31.848404
updated_at2023-06-21 07:59:20.634002
descriptionJump to tagged directories quickly with prtl.
homepage
repository
max_upload_size
id774318
size54,686
Shounak Amladi (ShounakA)

documentation

README

prtl

Small tool to keep track of your tagged directories. Portal to tagged locations quickly.

Installation

  • cargo install prtl

Build from Source

  • git clone https://github.com/ShounakA/prtl.git
  • cd prtl && cargo build --release

Auto Configure Shorthand

prtl ez-init --shell bash prtl ez-init --shell fish

Manually Configure Shorthand

Bash

  1. Add a new shell file path/to/your/newly/created/script/file.sh with:
    function p() {
       if [[ $1 = "get" ]]; then 
          cd $(prtl "$@")
       elif [ $1 = "set" ]; then
          $(prtl $@)
       else
          echo Global options will not work. Type \'prtl -h\' for more info.
          echo \'p\' short-hand only supports \'get\' and \'set\' commands. 
       fi
    }
    
  2. Update your .bashrc | .bash_profile | .profile to include: source path/to/your/newly/created/script/file.sh

Fish

  1. Add file p.fish to ~/.config/fish/functions with:
    function p
       if [ $argv[1] = "get" ]
          cd (eval prtl "$argv[1..-1]")
       else if [ $argv[1] = "set" ]
          eval prtl "$argv[1..-1]"
       else
          echo Global options will not work. Type \'prtl -h\' for more info.
          echo \'p\' short-hand only supports \'get\' and \'set\' commands. 
       end
    end
    

Usage

  • prtl -h -> Help command

  • prtl set <path> -> Sets the given path (relative or full) as your default prtl

  • prtl set <path> -t <tag> -> Sets the given path to the given tag

  • prtl get -> Gets your default prtl, and prints to stdout

  • cd $(prtl get) -> Take the prtl to your default directory

  • cd $(prtl get <tag>) -> Take the prtl to a tagged prtl

With shorthand configured

  • p get is short for cd $(prtl get)
  • p get <tag> is short for cd $(prtl get <tag>)
  • p set <path> is short for prtl set <path>
  • p set <path> -t <tag> is short for prtl set <path> -t <tag>

Contribute

Hello, if you stumble upon this repo and think it is worthy of your time you may contribute in the future. Currently, I don't have any PR templates, tests, or guides setup. But I may add them soon, stay tuned!

Commit count: 0

cargo fmt