path: root/README.md

# sailfish

A simple directory bookmark manager for the [fish](https://fishshell.com/)
shell.

## Installation

Use the provided `Makefile`. To install locally, run `PREFIX=~/.local make
install`.

## Usage

- `sail [name]` goes to the directory specified by `name`. If no name is given,
  go back to `$HOME`.
- `sail -a name` adds a bookmark for the current directory.
- `sail -e` opens the bookmark file with `$EDITOR`.
- `sail -p` prints all saved bookmarks.