OMP Wizard

A visual wizard to help users set up and customize their Oh-My-Posh prompts.

Getting Started

Mac & Linux

1. Download the binary for your system (Mac/Windows/Linux) from the Releases page
2. Open your terminal app and navigate (cd) to the directory where you downloaded the file (ex. Downloads)
3. Give the binary permissions with chmod +x omp-wizard
4. Run the wizard with ./omp-wizard [Note: Check Troubleshooting if mac blocks the command]
5. Follow on-screen directions
6. On completion the wizard will generate the theme file- generated-theme.omp.json
7. Add its path to your shell config following this guide
8. Restart your shell and enjoy :)

Windows

1. Double click the downloaded file or run it by .\win-omp-wizard.exe in the terminal [Note: Check Troubleshooting if facing trouble opening the executable]
2. Follow the on-screen directions
3. On completion the wizard will generate the theme file- generated-theme.omp.json
4. Add its path to your shell config following this guide
5. Restart your shell

Pro Tip: The wizard generates the file in the directory you run it from. If you keep the wizard and the generated JSON file in a permanent location, you can re-run the wizard later to overwrite it, and your shell will update automatically upon restart!

Feature Checklist

• Left prompt customization
  • User
  • Directory Path
  • Git Status
  • More blocks coming!
• Right prompt customization
  • Time
  • Shell
  • Dynamic Tooling blocks
  • More coming
• Three color modes (full/text/monochrome)
• Color Picker
  • Manual HEX entry
• Transient Prompt support
  • Transient Prompt customization
• Tab title customization
• Live render of prompt's current customization progress
• Agnoster support for path block
• Icon-less mode
• Advanced Mode
• Platform support
  • Apple Silicon Mac
  • Intel Mac
  • Windows
  • Linux
• Unified and streamlined setup process for all platforms
• More customization!

Suggestions and Feature Requests

This project is just two friends building something they needed, so it's bound to get heavily opinionated. However, we want to make it useful for everyone. So, if you have ideas for features, polish, or changes, please drop a note in Discussions

Troubleshooting

• If you don't see some of the diamonds or some parts of the TUI look weird, make sure you have a nerd font installed
• On Windows, if Microsoft Defender blocks you, just click on More Info and then Run Anyway. You can check the source code, promise I'm not distributing malware :)
• On MacOS, you might see a pop-up saying Apple could not verify if the software contains malware. Open System Settings->Privacy & Security. Scroll down until you see “mac-omp-wizard” was blocked to protect your Mac. Click on open anyway and repeat step 4 again.

References

• TUI library used - FTXUI | Docs
• Library used to generate JSON - nlohmann/json | Docs
• Find Diamonds
  • Powerline symbols
  • To check what a diamond looks like, run print '\u[hex code for icon]' in the terminal (\uef4d for example)