river_dreams

Crates.ioriver_dreams
lib.rsriver_dreams
version13.0.18
sourcesrc
created_at2025-01-11 22:50:07.540776+00
updated_at2025-05-10 15:12:49.478813+00
descriptionA tribal looking ZSH shell theme made to help you craft your most ambitious software projects. It is available for macOS and Linux.
homepagehttps://github.com/skippyr/river_dreams
repository
max_upload_size
id1512790
size997,294
Sherman Rofeman (skippyr)

documentation

README

≥v≥v River Dreams ≥v≥v

     

❡ About

A tribal looking ZSH shell theme made to help you craft your most ambitious software projects. It is available for macOS and Linux.

Caption: a preview of the River Dreams theme applied running eza in Kitty on macOS. The palette used is Flamerial and font is Monolisa (with fallback to Symbols Nerd Font). Background is AI art and provided as an wallpaper port by the Flamerial palette.

❡ Features

The left prompt shows:

Click to expand (...)
  • Your local IP address.
  • Your disk usage and its status.
  • Your battery charge and its status, if available.
  • A calendar showing the weekday, month and day of month.
  • A 24-hours clock showing the hours and minutes.
  • A decorator when you are the root user.
  • The exit code of the last command.
  • The active Python virtual environment, if one has been sourced.
  • The current directory path, abbreviated inside of Git repositories.
  • The active Git branch, when inside of Git repositories.
  • A decorator when you do not have permissions in the current directory.

The right prompt shows:

Click to expand (...)
  • The total number of each entry type in the current directory:
    • Files.
    • Directories.
    • Sockets.
    • Fifos.
    • Block devices.
    • Character devices.
    • Symlinks (they are not followed).
    • Hidden entries.
    • Temporary entries.
  • The total number of jobs running in the background.

❡ Install

Dependencies

The following dependencies must be installed before it:

  • ZSH: this is the shell the theme runs on. If you are on macOS, this is already the default one. On Linux, only a few distributions come with it by default, if that is not your case, you would need to change it manually.
  • Rust Toolchain: it will be used to build the project from source.
  • A font patched by the Nerd Fonts project: it provides the pretty symbols used by the software. Alternatively, you can use the font containing just its symbols as a fallback to an unpatched one if your terminal supports. Avoid having multiple ones installed due to possible font conflicts.
  • A terminal with good unicode support: it will be used to run the shell. It is highly recommended to use Kitty due to its amazing features and traits required to render the fonts used in the theme.

Use your OS package manager or HomeBrew to install these packages.

Procedures

  • Apply the Nerd Font installed in your terminal.
  • Install the theme using cargo. In case of an error, check cargo's output for troubleshooting.
cargo install river_dreams;
  • Initiate the theme in ~/.zshrc:
echo 'eval $(river_dreams init);' >> ~/.zshrc;
  • Reopen the shell.

❡ Help

If you need help related to this project, open a new issue in its issues pages or send an e-mail describing what is going on.

❡ Contributing

This project is open to review and possibly accept contributions in the form of bug reports and suggestions. If you are interested, send your contribution to its pull requests page or via e-mail.

❡ Special Thanks

Huge thanks to unixorn who has seen potential in this software and considered it an awesome plugin. If you want to see other amazing creations made by other developers, not just including themes, remember to check out its Awesome ZSH Plugins repository.

❡ License

This is free software licensed under the BSD-3-Clause License that comes WITH NO WARRANTY. Refer to the LICENSE file that comes in its source code for license and copyright details.

 

– 🐉❤️‍🔥 –
≥v≥v Here Be Dragons! ≥v≥
Made with love by 🍒 skippyr

Commit count: 0

cargo fmt