IlanCosman/tide
1
1
Fork 0
mirror of https://github.com/IlanCosman/tide.git synced 2024-09-20 13:47:16 +03:00
Code Issues Projects Releases Wiki Activity
🌊 The ultimate Fish prompt.
491 Commits 10 Branches 56 Tags 11 MiB
Shell 99.3%
Makefile 0.7%
aa40c45862
Go to file
Ilan Cosman aa40c45862 Update async gif
2021-01-04 15:16:47 -08:00
.github Move questions to discussions 2020-12-22 19:54:57 -08:00
completions Allow for installation into non-standard locations (#65) 2020-12-31 21:07:13 -08:00
conf.d Allow for installation into non-standard locations (#65) 2020-12-31 21:07:13 -08:00
docs Simplify nvm item, everyone is using nvm current now 2020-12-17 20:53:47 -08:00
functions Update async gif 2021-01-04 15:16:47 -08:00
resources Update async gif 2021-01-04 15:16:47 -08:00
CHANGELOG.md Changelog for v3.1.0 2020-12-31 21:20:26 -08:00
CODE_OF_CONDUCT.md Minor edits 2020-07-04 14:01:35 -07:00
CONTRIBUTING.md Allow for installation into non-standard locations (#65) 2020-12-31 21:07:13 -08:00
LICENSE.md Convert license to markdown 2020-07-04 13:53:26 -07:00
README.md Reorganize feature list 2020-12-22 17:43:22 -08:00

README.md

logo.svg

ci_badge ​ fish_version_badge ​ license_badge

header.png

The ultimate Fish prompt.

  • Out of the box: With four compelling styles and lots of options, you can have your ready-to-run cake and customize it too.
  • Flexible: Move content around or remove it, all without ever touching a line of code.
  • Extensible: Create custom content with simple fish functions that integrate seamlessly.
  • Fast: Asynchronous rendering makes Tide the fastest full-featured fish prompt.

Installation

System Requirements

Install with Fisher:

fisher install IlanCosman/tide

Features

Configuration Wizard

Run tide configure to open the the wizard in your terminal.

configuration_wizard


extensible.png

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.



flexible.png

Flexible

Using the items list for each side of the prompt, you have full control of which and where prompt sections display.



Asynchronous Rendering

Tide runs everything in the background so that your prompt will always feel snappy.

async

Asynchronous rendering also allows Tide to 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.


multi-line_right_prompt.png

Multi-Line Right Prompt

Fish can't do that yet can it!

Tide is the only Fish prompt capable of displaying a multi-line right prompt. All you have to do is add the newline item.


Configuration

See the configuration guide for variable 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 Tide's documentation and community health files.
  • Spacefish - Inspired some of Tide's items.