Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/MikeDacre/cdbk
A ZSH plugin to allow easy named directory creation - shortcuts to any directory you want
https://github.com/MikeDacre/cdbk
Last synced: about 2 months ago
JSON representation
A ZSH plugin to allow easy named directory creation - shortcuts to any directory you want
- Host: GitHub
- URL: https://github.com/MikeDacre/cdbk
- Owner: MikeDacre
- License: mit
- Created: 2014-09-05T18:21:35.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-03-25T22:45:13.000Z (about 6 years ago)
- Last Synced: 2024-01-24T16:46:53.544Z (4 months ago)
- Language: Shell
- Size: 16.6 KB
- Stars: 14
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-zsh-plugins - cdbk - A ZSH plugin to allow easy named directory creation - shortcuts to any directory you want. (Plugins / ZSH on Windows)
- fucking-awesome-zsh-plugins - cdbk - A ZSH plugin to allow easy named directory creation - shortcuts to any directory you want. (Plugins / ZSH on Windows)
- fucking-awesome-zsh-plugins - cdbk - A ZSH plugin to allow easy named directory creation - shortcuts to any directory you want. (Plugins / ZSH on Windows)
- awesome-zsh-plugins - cdbk - A ZSH plugin to allow easy named directory creation - shortcuts to any directory you want. (Plugins / ZSH on Windows)
- awesome-zsh-plugins - cdbk - A ZSH plugin to allow easy named directory creation - shortcuts to any directory you want. (Plugins / Zinit (née zplugin))
README
cdbk
====
A simple zsh function to make management of zsh
named directories easier. It keeps all named directories in a
file and uses grep, sed, echo, and perl to parse and modify
this file in order to add, change or remove bookmarks.
Because it uses the zsh named directory function, full zsh path
completion is possible. For example, if you wanted to access the
directory ``/Users/me/Work/Project13/Samples/FromEster/July/``
and that directory had many subdirectories including the subdirectory
``./Revision6/pictures``, you could easily bookmark the parent directory
with the command:
```
cdbk -a ejul /Users/me/Work/Project13/Samples/FromEster/July/
```
Then, to cd to the subdirectory, just type ``cd ~ejul/Revision6/pictures``,
autocompletion will work too.
This file also provides the function ``folder_name()``, which returns
a formatted list of the names of the current folder for use in
a prompt. To include the folder name in your prompt use e.g.:
``export PROMPT=$PROMPT $(folder_name)``
Very simple cdbk completion is included to make replacing and
deleting bookmarks easier.
This program was heavily inspired by Stan Angeloff's function
of the same name found here:
http://blog.angeloff.name/post/1027007406/cd-with-bookmarks-and-auto-completion-for-zsh
```
Usage: cdbk {-a,-r,-d,-l} [path] (run with no paramaters for info)
-a: Create bookmark (uses current dir if no path)
-r: Replace bookmark (uses current dir if no path)
-d: Delete bookmark
-l: List all currently enabled bookmarks
```
Requirements: Needs to be sourced from a zsh startup file, or use oh-my-zsh
# Installation
## [Antigen](github.com/zsh-users/antigen)
If you're using [Antigen](github.com/zsh-users/antigen), just add `antigen bundle MikeDacre/cdbk` to your `.zshrc` file where you're loading your other zsh plugins.
## [Oh-My-Zsh](https://github.com/robbyrussell/oh-my-zsh)
1. `mkdir -p ~/oh-my-zsh/custom/plugins`
2. `cd ~/oh-my-zsh/custom/plugins`
3. `git clone [email protected]:MikeDacre/cdbk.git`
4. `echo "plugins+=(cdbk)" >> ~/.zshrc`
## [Zgen](tarjoilija/zgen)
If you're using [Zgen](tarjoilija/zgen), add `zgen load MikeDacre/cdbk` to your `.zshrc` file where you're loading your other zsh plugins.
Created by: Mike Dacre
Created on: 19-11-11
Version: 1.1
License: MIT License - Open Source. Use as you wish