https://github.com/techwizrd/fishmarks
Bookmark and jump to directories faster than a sailfish! Fishmarks is a clone of bashmarks for the Fish shell.
https://github.com/techwizrd/fishmarks
fish fish-plugin
Last synced: 3 months ago
JSON representation
Bookmark and jump to directories faster than a sailfish! Fishmarks is a clone of bashmarks for the Fish shell.
- Host: GitHub
- URL: https://github.com/techwizrd/fishmarks
- Owner: techwizrd
- License: apache-2.0
- Created: 2013-05-21T18:04:27.000Z (about 13 years ago)
- Default Branch: master
- Last Pushed: 2026-03-05T05:02:20.000Z (4 months ago)
- Last Synced: 2026-03-05T09:56:28.556Z (4 months ago)
- Topics: fish, fish-plugin
- Language: Shell
- Homepage:
- Size: 57.6 KB
- Stars: 116
- Watchers: 4
- Forks: 14
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
- Authors: AUTHORS.md
Awesome Lists containing this project
- awesome-starred - techwizrd/fishmarks - Bookmark and jump to directories faster than a sailfish! Fishmarks is a clone of bashmarks for the Fish shell. (others)
README
# fishmarks
[](https://github.com/techwizrd/fishmarks/actions/workflows/ci.yml?query=branch%3Amaster)
[](https://github.com/techwizrd/fishmarks/releases)
[](https://fishshell.com/)
[](https://semver.org/)
[](LICENSE)
[](CONTRIBUTING.md)
Fishmarks is a clone of [bashmarks](https://github.com/huyng/bashmarks) for the
[Fish shell](https://fishshell.com/). Fishmarks is compatible with existing bashmarks,
and bookmarks added using fishmarks are also available in bashmarks.
## Demo
This demo is recorded with [asciinema](https://asciinema.org/) and rendered with
[agg](https://github.com/asciinema/agg).
## Installation
### Automatic Installation
To install fishmarks automatically, paste the following in your terminal.
```fish
curl -fsSL https://raw.githubusercontent.com/techwizrd/fishmarks/master/install.fish | fish
```
Please note that you should _never_ install things by piping untrusted install scripts
downloaded through `curl` directly into your shell (whether `bash` or `fish`).
Even if you read through the install script and think you understand it, you could still
be prone to a
[man-in-the-middle](https://en.wikipedia.org/wiki/Man-in-the-middle_attack) attack
or other security vulnerabilities.
While manual installations are tedious, they are recommended for situations where
security is a concern (and it should almost always be a concern).
### Fisher Installation
If you use [Fisher](https://github.com/jorgebucaran/fisher), install fishmarks with:
```fish
fisher install techwizrd/fishmarks
```
### Fundle Installation
If you use [Fundle](https://github.com/danhper/fundle), add fishmarks to your fish config:
```fish
fundle plugin 'techwizrd/fishmarks'
fundle init
```
Then install plugins:
```fish
fundle install
```
Fish plugin managers load fishmarks from `functions/`, `conf.d/`, and `completions/`.
The top-level `marks.fish` file remains as a compatibility loader
for existing manual installs.
### Manual Installation
To install fishmarks manually:
1. Clone fishmarks into `~/.fishmarks`.
```fish
git clone https://github.com/techwizrd/fishmarks.git ~/.fishmarks
```
1. Source `~/.fishmarks/marks.fish` from a file in `~/.config/fish/conf.d/`.
```fish
mkdir -p ~/.config/fish/conf.d
printf '# Load fishmarks (https://github.com/techwizrd/fishmarks)\n' \
'source ~/.fishmarks/marks.fish\n' > ~/.config/fish/conf.d/fishmarks.fish
```
### Update to the latest version
To update to the latest version of fishmarks:
1. Navigate to the directory where fishmarks is installed (`~/.fishmarks` by default).
```fish
cd ~/.fishmarks
```
1. Use git to fetch the latest version.
```fish
git fetch --all
```
1. Pull the latest version.
```fish
git pull --ff-only
```
## Usage
### Commands
```text
save_bookmark [--force] [bookmark_name] (or s) - Saves the current directory as "bookmark_name"
rename_bookmark - Renames an existing bookmark
bookmark_exists - Returns success if bookmark exists
go_to_bookmark (or g) - Goes (cd) to the directory associated with "bookmark_name"
print_bookmark (or p) - Prints the directory associated with "bookmark_name"
delete_bookmark (or d) - Deletes the bookmark
list_bookmarks [--names-only] (or l) - Lists all available bookmarks
fishmarks_doctor - Checks bookmarks file for common issues
fishmarks_version - Prints the installed fishmarks version
```
### Configuration Variables
All variables must be set before `marks.fish` is sourced in fish startup files.
- `SDIRS` - default: `~/.sdirs`; location where bookmarks are stored.
- `NO_FISHMARKS_COMPAT_ALIASES` - disable bashmark-compatible aliases such as `p`.
### Example
```text
[~]$ cd /var/www/
[/var/www]$ s webfolder
[/usr/local/lib]$ cd /usr/local/lib/
[/usr/local/lib]$ s locallib
[/usr/local/lib]$ l
locallib /usr/local/lib
webfolder /var/www
[/usr/local/lib]$ g webfolder
[/var/www]$
```
## Running tests
Run the test suite with:
```fish
fish tests/run.fish
```
Run syntax and formatting checks with:
```fish
fish tests/check.fish
```
Or with make:
```sh
make check
```
Run all checks and tests with:
```sh
make test
```
## Development workflow
Install [prek](https://prek.j178.dev/latest/) (or pre-commit) hooks locally:
```fish
prek install
```
Run all hooks on demand:
```fish
prek run --all-files
```
GitHub Actions CI runs checks (`tests/check.fish`, `tests/run.fish`), installer smoke tests,
and plugin-manager smoke tests for Fisher and Fundle on every push and pull request.
## Versioning
fishmarks follows [Semantic Versioning](https://semver.org/).
Notable changes are tracked in `CHANGELOG.md`.
### Contributing
See `CONTRIBUTING.md` for setup, validation commands, and pull request guidelines.
## License
Copyright 2013-present Kunal Sarkhel
Licensed under the Apache License, Version 2.0 (the "License"); you may not use
this file except in compliance with the License. You may obtain a copy of the
License at `https://www.apache.org/licenses/LICENSE-2.0`.
Unless required by applicable law or agreed to in writing, software distributed
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied. See the License for the
specific language governing permissions and limitations under the License.