**The ultimate Fish prompt.**
- **Fast -** Asynchronous rendering makes Tide instantly responsive in any situation.
- **Friendly -** An interactive configuration wizard lets you design your prompt efficiently.
- **Flexible -** Pure-Fish construction means you can easily control existing content or create your own that will integrate seamlessly.
## Installation
### System Requirements
- The **latest** version of [Fish][], currently 4.8.0. [Using an older version of Fish?][]
- A [Nerd Font][nerd fonts] installed and enabled in your terminal (or your terminal already supports [fallback fonts](#fallback-font-support) with Nerd Font support).
Install with [Fisher][]:
```console
fisher install plttn/tide@v7
```
Install manually
This script may not work for all use cases.
```fish
set -l _tide_tmp_dir (command mktemp -d)
curl https://codeload.github.com/plttn/tide/tar.gz/v7 | tar -xzC $_tide_tmp_dir
command cp -R $_tide_tmp_dir/*/{completions,conf.d,functions} $__fish_config_dir
fish_path=(status fish-path) exec $fish_path -C "emit _tide_init_install"
```
## Features
### Configuration Wizard
Run `tide configure` to open the wizard in your terminal.
![configuration_wizard][]
### Flexible
Using the [`items`][] list for each side of the prompt, you have full control of which and where prompt sections display.
### Extendable
If there isn't an item that fits your needs you can make your own (and hopefully submit a pull request) or ask for it to be made by opening an issue.
### Asynchronous Rendering
Tide runs everything in the background so that your prompt will always feel snappy.
![async][]
Asynchronous rendering also lets Tide display more information than other prompts. For example, most prompts don't display the number of untracked, modified, or deleted files in a git repository because it's too slow to compute.
### Current directory that just works
The current working directory is the most important part of any shell prompt. Tide highlights the critical parts and truncates with the least loss of information when horizontal space is scarce.
When the full directory doesn't fit, the leftmost segment is truncated to its shortest unique prefix. In the example above, `Documents` becomes `Doc` instead of `D` because that could be confused with `Downloads`. Important segments are bold and never truncated. These include the last segment, root of a Git repository etc.
_Tip_: If you copy-paste a truncated path and hit tab, it will complete to the original.
## Documentation
See the [Wiki][] for documentation.
## Contributing
From the smallest typo to the largest feature, contributions of any size or experience level are welcome!
If you're interested in helping contribute to Tide, please take a look at the [Contributing Guide][].
## Acknowledgments
- [ilancosman/tide][] - The original. The work here is built on Ilan's work, and is indebted to him.
- [Powerlevel10k][] - Inspired Tide's creation. Because Tide aims to replicate Powerlevel10k's amazing capabilities, small sections of documentation have been borrowed when rewording the language would reduce clarity.
- [Starship][] - Inspired elements of Tide's documentation and community health files.
- [Spacefish][] - Inspired some of Tide's items.
## Appendix
### Fallback Font Support
Many terminal emulators already support fallback fonts, so patching your font isn't
necessary.
#### Enabled by default
- [Ghostty](https://ghostty.org/docs/config#zero-configuration-philosophy)
- [Wezterm](https://wezterm.org/config/lua/wezterm/nerdfonts.html)
- [kitty](https://sw.kovidgoyal.net/kitty/faq/#kitty-is-not-able-to-use-my-favorite-font)
- [Windows Terminal](https://github.com/microsoft/terminal/pull/16821)
#### Enabled as option
- [iTerm](https://iterm2.com/documentation-preferences-profiles-text.html)
[`items`]: https://github.com/plttn/tide/wiki/Configuration#items
[async]: https://yeet.jack.is/u/async.png
[configuration_wizard]: https://yeet.jack.is/u/configuration_wizard.webp
[contributing guide]: CONTRIBUTING.md
[fish]: https://fishshell.com/
[fisher]: https://github.com/jorgebucaran/fisher
[nerd fonts]: https://github.com/ryanoasis/nerd-fonts
[powerlevel10k]: https://github.com/romkatv/powerlevel10k/
[spacefish]: https://github.com/matchai/spacefish
[starship]: https://github.com/starship/starship
[using an older version of fish?]: https://github.com/plttn/tide/wiki/Fish-version-compatibility
[wiki]: https://github.com/plttn/tide/wiki
[ilancosman/tide]: https://github.com/IlanCosman/tide