51ce73e1eb
Fixed README typo |
||
---|---|---|
.github | ||
completions | ||
conf.d | ||
functions | ||
tide_theme | ||
tools | ||
CODE_OF_CONDUCT.md | ||
CONTRIBUTING.md | ||
LICENSE.md | ||
README.md |
A modern prompt manager for the Fish shell.
- Out of the box: With four compelling styles and myriad options, you can have your out-of-the-box cake and customize it too.
- Flexible: Move content around, remove it, or add it back, all without ever touching the code.
- Powerful: Impress all your Fish friends with alien technologies like a multi-line right prompt.
- Extensible: Create custom content with simple fish functions that integrate seamlessly.
Installation
Prerequisites
- Git
- Fish ≥ 3.1
- A Nerd Font installed and enabled in your terminal (for example the recommended font).
Source and run the install function
curl -sL git.io/tide | source && tide_install
Features
Configuration Wizard
Run tide configure
to open the the wizard in your terminal.
Flexible
Tide uses "items", small functions that create the prompt contents. Using the items
list for each side of the prompt, you have full control of where and which items display.
Multi-Line Right Prompt
Fish can't do that yet can it!
Tide takes care of all the multi-line logic and printing for you. All you have to do is add the newline
item.
Extensible
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.
Pure Emulation
Tide can easily produce the same prompt as Pure (with a number of improvements). Run tide configure
and select the Pure style.
All of Tide's features are available while using Pure style, though it displays less information by default than Lean style.
Documentation
See the wiki for the full 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.
Fonts
Meslo Nerd Font
Gorgeous monospace font designed by Jim Lyles for Bitstream, customized for Apple, enhanced by André Berg, and finally patched by Roman Perepelitsa of Powerlevel10k with scripts originally developed by Ryan McIntyre of Nerd Fonts. Contains all the glyphs and symbols that Tide may need. Battle-tested in dozens of different terminals on all major operating systems.
Font Installation
Download these four ttf files:
Open each file and click "Install". This will make the MesloLGS NF
font available to all applications on your system. Configure your terminal to use this font.
Acknowledgments
- Powerlevel10k - Inspired much of Tide's documentation, resources, ideas, and design.
- Starship - Inspired elements of the documentation.