Skip to content

Latest commit

 

History

History
88 lines (56 loc) · 3.1 KB

README.md

File metadata and controls

88 lines (56 loc) · 3.1 KB
Raw

zshmarks

A port of Bashmarks (by Todd Werth), 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 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 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' 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), 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.)