https://github.com/regarager/shiko-prompt

https://github.com/regarager/shiko-prompt

Last synced: 5 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/regarager/shiko-prompt
• Owner: regarager
• License: gpl-3.0
• Created: 2025-01-31T06:50:28.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2026-01-28T21:26:34.000Z (5 months ago)
• Last Synced: 2026-01-29T12:12:04.244Z (5 months ago)
• Language: Rust
• Size: 157 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-zsh-plugins - shiko - Minimalist prompt with decorators for VCS information and current directory. (Themes / ZSH on Windows)
• fucking-awesome-zsh-plugins - shiko - Minimalist prompt with decorators for VCS information and current directory. (Themes / ZSH on Windows)

README

          
# shiko-prompt

## Screenshots

### Default Theme

![Normal](./images/default.png)

![With VCS](./images/default_vcs.png)

![Python venv](./images/default_venv.png)

### Duskfox Theme

![Normal](./images/duskfox.png)

![With VCS](./images/duskfox_vcs.png)

![Python venv](./images/duskfox_venv.png)

### Campfire Theme

![Normal](./images/campfire.png)

![With VCS](./images/campfire_vcs.png)

![Python venv](./images/campfire_venv.png)

## Development Dependencies

Install the following dependencies: `rust`

Ex: `sudo pacman -Syu rust` (Arch)

## Installation

1. Clone the repository - `git clone https://github.com/regarager/shiko-prompt`

2. Move repository into home-folder (or other preferred directory) - `mv shiko-prompt ~`

3. Build the prompt binary - `cargo build --release` (alternatively, `SHIKO_THEME=./themes/.ron cargo build --release` for a different theme)

4. Add `source ~/shiko-prompt/shiko.zsh` to your `~/.zshrc` and reload it with `source ~/.zshrc`.

5. Enjoy!

## Customization

As of now, there is no configuration wizard, but you may change colors in `config.ron` and rebuilding the `shiko-prompt` binary.