Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/jocelynmallon/zshmarks

A port of Bashmarks (simple bookmarking plugin by Todd Werth) for oh-my-zsh
https://github.com/jocelynmallon/zshmarks

Last synced: about 2 months ago
JSON representation

A port of Bashmarks (simple bookmarking plugin by Todd Werth) for oh-my-zsh

Awesome Lists containing this project

README 

        
zshmarks

========



A port of [Bashmarks (by Todd Werth)](https://github.com/twerth/bashmarks), a simple command line bookmarking plugin, for oh-my-zsh



How to install

--------------



oh-my-zsh

---------

* Download the script or clone this repository in [oh-my-zsh](http://github.com/robbyrussell/oh-my-zsh) plugins directory:



        cd ~/.oh-my-zsh/custom/plugins

        git clone https://github.com/jocelynmallon/zshmarks.git



* Activate the plugin in `~/.zshrc`:



        plugins=( [plugins...] zshmarks [plugins...])



* Source `~/.zshrc`  to take changes into account:



        source ~/.zshrc



antigen

-------

Add `antigen bundle jocelynmallon/zshmarks` to your .zshrc where you're adding your other plugins. Antigen will clone the plugin for you and add it to your antigen setup the next time you start a new shell.



prezto

------

For most people the easiest way to use zshmarks with [prezto](https://github.com/sorin-ionescu/prezto) is to manually clone the zshmarks repo to a directory of your choice (e.g. /usr/local or ~/bin) and symlink the zshmarks folder into your zpretzo/modules folder:



        ln -s ~/bin/zshmarks ~/.zprezto/modules/zshmarks



Alternatively, you can add the zshmarks repository as a submodule to your prezto repo by manually editing the '.gitmodules' file:



        [submodule "modules/zshmarks"]

        	path = modules/zshmarks

        	url = https://github.com/jocelynmallon/zshmarks.git



Then make sure you activate the plugin in your .zpreztorc file:



        zstyle ':prezto:load' pmodule \

        zshmarks \

        ...



zplug

-----

Add the following to your .zshrc file somewhere after you source zplug.



        zplug "jocelynmallon/zshmarks"



Commands/Usage:

------



* jump - used to 'jump' (cd) to the given bookmark directory. ~~If the bookmark directory contains a 'setenv-source-me.sh' file, it will check to see if it's already been sourced, and source the file if necessary.~~ This has been deprecated for security and simplicity. If users need this functionality, the zsh plugin ['autoenv'](https://github.com/horosgrisa/autoenv) is a good choice.



        jump 'foo'



* bookmark - used to create a new bookmark for your current working directory



        cd 'some_dir'

        bookmark 'foo'



* deletemark - used to delete a bookmark



        deletemark 'foo'



* showmarks - prints a list of all saved bookmarks, or print the directory information for a single, specific bookmark



        showmarks 'foo'

        $HOME/foo



Notes/Tips:

-----------



You can change the location of the bookmarks file (default is $HOME/.bookmarks) by adding the environment variable 'BOOKMARKS_FILE' to your shell profile.



        export BOOKMARKS_FILE="foo/bar"



If you were expecting this to be a port of similarly named [Bashmarks (by huyng)](https://github.com/huyng/bashmarks), you can setup zshmarks to behave in roughly the same way by adding the following aliases to your shell setup files/dotfiles:



        alias g="jump"

        alias s="bookmark"

        alias d="deletemark"

        alias p="showmarks"

        alias l="showmarks"



(You can also omit the "l" alias, and just use p without an argument to show all  bookmarks.)