https://github.com/Readf0x/integral-prompt
Math inspired zsh prompt
https://github.com/Readf0x/integral-prompt
Last synced: 2 months ago
JSON representation
Math inspired zsh prompt
- Host: GitHub
- URL: https://github.com/Readf0x/integral-prompt
- Owner: Readf0x
- License: gpl-3.0
- Created: 2024-08-29T01:11:23.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-26T20:48:25.000Z (11 months ago)
- Last Synced: 2024-12-26T21:25:51.425Z (11 months ago)
- Language: Shell
- Size: 98.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-zsh-plugins - integral - Math-inspired, includes decorators for time, current directory and `git` status. (Themes / ZSH on Windows)
- trackawesomelist - integral (⭐0) - Math-inspired, includes decorators for time, current directory and `git` status. (Recently Updated / [Sep 15, 2024](/content/2024/09/15/README.md))
README
# Integral Prompt
## About
This prompt theme was created mostly due to my dissatisfaction with existing ones. My main issues were:
- overcomplicated configuration
- feature bloat
- wrapping issues
## Installation
~~Load with your favorite plugin loader (only officially supports [antidote](https://antidote.sh/)), or source `init.zsh` in your `.zshrc`.~~
For the time being it can only be automatically installed with nix.
### Flake install (Home Manager)
Add to your inputs and add `integral-prompt.homeManagerModules.default` to your home manager imports
```nix
# flake.nix
{
inputs = {
integral-prompt.url = "github:readf0x/integral-prompt";
};
}
```
```nix
# home.nix
{ inputs, ... }: {
imports = [ inputs.integral-prompt.homeManagerModules.default ];
programs.zsh = {
integral-prompt.enable = true;
};
}
```
### Manual installation
Install golang and run `./build.sh` to generate a tarball for generic linux.
For Debian based distros, run `./build.sh deb`.
## Usage
To configure, add a `~/.integralrc` file. It can also be placed at:
- `$XDG_CONFIG_HOME/integralrc`
- `$XDG_CONFIG_HOME/integralrc.json`
- `$XDG_CONFIG_HOME/integral/rc`
- `$XDG_CONFIG_HOME/integral/rc.json`
If `$XDG_CONFIG_HOME` is undefined, it will fall back to `~/.config`
The configuration options aren't yet documented, but if you have a JSON language server simply add
```json
"$schema": "/usr/share/integral/schema.json"
```
to the top of your configuration, and the LSP can list all available options. I know that's not ideal, but I
haven't added [jsonschema](https://github.com/invopop/jsonschema) description fields to the config types. Once that's done, I should be able to generate
actual documentation as well.
## Planned Features
- [x] Configuration files
- [x] Transient Prompt
- [x] Multi-line prompt
- [x] Rerender on terminal resize
- [x] Module loader
- [x] Colors
- [x] Formatting
- [x] Icons
- [x] Positions
- [x] Order
- [x] Seperators
- [x] Dynamic triggers
- [x] Right prompt
- [ ] Plugin Support
- [ ] Documentation
- [ ] Module timeouts
### Planned Modules
- [x] Background Jobs
- [x] Battery
- [x] CPU
- [x] CWD
- [x] Clock
- [x] [Direnv](https://github.com/direnv/direnv)
- [x] Error Codes
- [x] Git
- [x] Nix Shell
- [x] SSH
- [x] Uptime
- [x] Vim