https://github.com/nkurata/zsh-theme
Minimal-OS is a sleek and simple Zsh theme designed for use with Oh-My-Zsh. It provides a minimalist prompt with helpful Git status indicators and system-specific icons.
https://github.com/nkurata/zsh-theme
Last synced: 5 months ago
JSON representation
Minimal-OS is a sleek and simple Zsh theme designed for use with Oh-My-Zsh. It provides a minimalist prompt with helpful Git status indicators and system-specific icons.
- Host: GitHub
- URL: https://github.com/nkurata/zsh-theme
- Owner: nkurata
- License: mit
- Created: 2024-06-01T10:22:37.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-14T14:59:12.000Z (10 months ago)
- Last Synced: 2025-05-18T09:12:27.634Z (6 months ago)
- Language: Shell
- Homepage:
- Size: 14.6 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 - minimal-os - A minimalist prompt with helpful `git` status and system-specific decorators. (Themes / ZSH on Windows)
- fucking-awesome-zsh-plugins - minimal-os - A minimalist prompt with helpful `git` status and system-specific decorators. (Themes / ZSH on Windows)
README
# Minimal-OS Zsh Theme
**Minimal-OS** is a sleek and simple Zsh theme designed for use with Oh-My-Zsh. It provides a minimalist prompt with helpful Git status indicators and system-specific icons.
Please consider Favoriting this repo if you enjoy the theme!
## Features
- **System Icons:** Displays an icon based on your operating system:
- macOS:
- Linux: 🐧
- Windows (Cygwin/MSYS): ⊞
- Unrecognised: ❯
- **Git Integration:** Indicates the status of your Git repository with different symbols for:
- Modified files
- Untracked files
- Clean state
- Behind remote status
## Installation
1. **Oh-My-Zsh Installation:**
Make sure you have Oh-My-Zsh installed. If not, you can install it by following the instructions [here](https://github.com/ohmyzsh/ohmyzsh).
2. **Download the Theme:**
Save the theme file `minimal-os.zsh-theme` to the Oh-My-Zsh custom themes directory:
```sh
curl -o $ZSH_CUSTOM/themes/minimal-os.zsh-theme https://raw.githubusercontent.com/nkurata/zsh-theme/main/minimal-os.zsh-theme
```
3. **Set the Theme:**
Edit your `~/.zshrc` file to set `ZSH_THEME` to `minimal-os`:
```sh
ZSH_THEME="minimal-os"
```
4. **Apply the Changes:**
Reload your Zsh configuration by running:
```sh
source ~/.zshrc
```
## Example Prompt
With the `minimal-os` theme, your prompt will look something like this:
```
~/my-project (main) ↑12↓ 23:45:56
🐧
```
This indicates:
- The current directory is `~/my-project`
- The current Git branch is `main`
- There are 12 changes ahead of the remote branch
- The current time is `23:45:56`
- You are on a Linux system
## Examples
- Apple System
- Linux System
- Windows System
- Unrecognised System
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
## Contributing
Contributions are welcome! Please fork the repository and submit a pull request for any enhancements or fixes.
## Acknowledgments
- Inspired by various Zsh themes available in the Oh-My-Zsh community.
Enjoy your new minimal and efficient Zsh prompt with **Minimal-OS**!