Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/n-r-k/shellmarks
Simple directory bookmark management via symlinks. [MIRROR OF https://codeberg.org/NRK/shellmarks]
https://github.com/n-r-k/shellmarks
bash bookmarks directory-bookmarks zsh
Last synced: 25 days ago
JSON representation
Simple directory bookmark management via symlinks. [MIRROR OF https://codeberg.org/NRK/shellmarks]
- Host: GitHub
- URL: https://github.com/n-r-k/shellmarks
- Owner: N-R-K
- License: gpl-3.0
- Created: 2021-08-11T08:13:30.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-04-01T09:45:47.000Z (7 months ago)
- Last Synced: 2024-04-01T10:46:39.072Z (7 months ago)
- Topics: bash, bookmarks, directory-bookmarks, zsh
- Language: Shell
- Homepage: https://codeberg.org/NRK/shellmarks
- Size: 92.8 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Shellmarks
[](https://codeberg.org/NRK/shellmarks)
A simple shell script for managing bookmarks via symlinks.
Shellmarks is heavily inspired by [bashmarks][].
Unlike bashmarks however, shellmarks uses symlinks to create and manage bookmarks.
[bashmarks]: https://github.com/huyng/bashmarks
This is a better and more flexible approach because now you can point many
different application, such as your filemanger or the filepicker etc, to a
single unified directory. You no longer need to maintain and sync different
bookmarks for different applications.
## Installation
Clone the repo.
```console
$ git clone https://codeberg.org/NRK/shellmarks.git
```
Then just copy/move `shellmarks` into your `$PATH` (e.g `/usr/local/bin/`).
Instead of copying, you can also create a symlink. This way you can do a git
pull to get updates.
## Usage
By default shellmarks uses `~/.local/share/shellmarks` as the bookmark
directory. This can be changed via the `$SH_MARKS` environment variable.
Add a bookmark. If `target` is omitted the current working directory `$PWD`,
will be used.
```
shellmarks add [target]
```
List all the available bookmarks. When called with the `-n` flag, it will only
print the bookmark name without printing the realpath.
```
shellmarks ls [-n]
```
Remove a bookmark.
```
shellmarks rm
```
Print the real path of a bookmark.
```
shellmarks path
```
All of these commands are meant to be aliased. In the example image above I'm
using the following aliases. Copy paste them into your `~/.bashrc` or
`~/.zshrc`.
```sh
alias l="shellmarks ls"
alias d="shellmarks rm"
alias sd="shellmarks add"
```
You can also disable the colored output by calling shellmarks with the `-c` flag.
The [`NO_COLOR`][no-color] environment variable is also respected.
[no-color]: https://no-color.org
### Cd-ing into a directory
Since shellmarks simply creates symlinks, there's a couple ways to actually
achieve this. My preferred way is to adding a small function wrapper to your
shell.
Add the following function into your `~/.bashrc` or `~/.zshrc`.
```sh
g() {
local cddir="$(shellmarks path "$1")"
case "$cddir" in
/*) cd "$cddir" ;;
*) printf '%s' "$cddir" ;;
esac
}
```
Now you can do `g ` to cd into a directory form the command line. You are
free to change `g` to something else here if you wish.
Another way would be to utilize the [`CDPATH`][cdpath] environment variable.
Do be careful to not modify this variable outside your interactive shell, as
that might lead to undesirable side-effects.
[cdpath]: https://linux.101hacks.com/cd-command/cdpath/
## Auto Complete
### ZSH
Add the following to your `.zshrc` to get auto-completion.
```zsh
_shmk_autocomp() { reply=($(shellmarks -c ls -n)); }
compctl -K _shmk_autocomp shellmarks
compctl -K _shmk_autocomp g # for the cd function, change 'g' if your function is named differently
```
### Bash
Add the following to your `.bashrc` to get auto-completion.
```bash
bind 'set show-all-if-ambiguous on' # optional, but good to have
_shmk_autocomp() {
local curw
COMPREPLY=()
curw=${COMP_WORDS[COMP_CWORD]}
COMPREPLY=($(compgen -W '`shellmarks -c ls -n`' -- $curw))
return 0
}
complete -F _shmk_autocomp g # for the cd function, change 'g' if your function is named differently
complete -F _shmk_autocomp d # for the d alias, change it to fit your alias
```