Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eth-p/fish-promptfessional
Your flexible and highly-customizable Fish shell prompt.
https://github.com/eth-p/fish-promptfessional
customizable-prompt fish fish-plugin fish-prompt fish-shell fisher fisherman git-integration oh-my-fish prompt
Last synced: 6 days ago
JSON representation
Your flexible and highly-customizable Fish shell prompt.
- Host: GitHub
- URL: https://github.com/eth-p/fish-promptfessional
- Owner: eth-p
- License: mit
- Created: 2021-07-05T09:49:44.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-02-18T09:56:58.000Z (9 months ago)
- Last Synced: 2024-02-24T11:44:57.075Z (8 months ago)
- Topics: customizable-prompt, fish, fish-plugin, fish-prompt, fish-shell, fisher, fisherman, git-integration, oh-my-fish, prompt
- Language: Shell
- Homepage:
- Size: 171 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Promptfessional
Your flexible and highly-customizable Fish shell prompt.
Default theme inspired by [bobthefish](https://github.com/oh-my-fish/theme-bobthefish).
## Install
With [fisher](https://github.com/jorgebucaran/fisher):
```fish
fisher add eth-p/fish-promptfessional
function fish_prompt
promptfessional_default_prompt
end
funcsave fish_prompt
```
Check out the [build your own prompt section](#build-your-own-prompt) for info on how to customize your prompt.
## Why choose Promptfessional?
Promptfessional is a great choice if you want to:
- Customize your prompt without doing everything from scratch.
- Add your own prompt components without worrying about updates.
- Have a prompt that's both stylish and fast (<50ms).
## How it works
Promptfessional is all about giving you the power to customize your own prompt. To do this, Promptfessional takes a modular approach to displaying prompts.
Your prompt is divided into sections, and each section contains one or more components. Individual components display some kind of useful information, such as the number of running jobs, or the path of the working directory.
### Build your own prompt
Don't like the default prompt? That's ok, you can customize it however you like. Let's take a look at the default to see how to customize a prompt:
```fish
function fish_prompt
promptfessional section status --delimiter=' '
promptfessional show status
promptfessional show private
promptfessional show jobs
promptfessional show sudo
promptfessional section path --pattern=' %s '
promptfessional show path \
--collapse-home \
--abbrev-parents \
--decoration promptfessional_decoration_git \
--git-hide-branch main \
--git-hide-branch master
promptfessional end
promptfessional literal " "
end
```
When you call `promptfessional section [name]`, you're creating a new prompt section. Subsequent calls to `promptfessional show [component]` will add a component to your section.
For the "status" section above, you can see that it's made up of three components:
- `status`, which shows the exit code of the last command.
- `private`, which shows you when the shell was started with `--private`.
- `jobs`, which shows you if any background jobs are running.
- `sudo`, which shows you if you're running a root shell.
When any of these components are visible, they will be displayed in order of first appearance.
You might also notice that the section also has an option, `--delimiter=' '`. This tells Promptfessional to put a space between each displayed component within this section.
Next, let's look at the "path" section. This section only has the `path` component, but that component has a bunch of different options. You can find out about most of them [in the documentation](#documentation), but here's a quick mention for the `--decoration` option:
Decorations are special components that are applied to individual directories in the path. These display contextual info about their respective directories (e.g. git status).
### Build your own component
See [docs/custom_component.md](docs/custom_component.md) for custom components.
See [docs/custom_decoration.md](docs/custom_decoration.md) for custom path decorations.
## Advanced Tips
### Powerline Arrows
Promptfessional supports Powerline arrows between prompt sections.
You can enable them by adding this right below your `fish_prompt` function:
```fish
function fish_prompt
promptfessional enable arrow
...
end
```
If you want to have an ending arrow, you can use this snippet:
```fish
function fish_prompt
...
set_color (string replace -- "--background=" "" (promptfessional color section.path --or=component.path --only-background --print))
promptfessional literal "{arrow}\x1B[0m "
end
```
## Documentation
Want to learn more about the available components and options?
Check out the documentation for built-in components:
### Core
- [promptfessional color](docs/promptfessional_color.md)
- [promptfessional enable](docs/promptfessional_enable.md)
- [promptfessional section](docs/promptfessional_section.md)
- [promptfessional util ansi_extract](docs/promptfessional_util_ansi_extract.md)
- [promptfessional util ansi_strip](docs/promptfessional_util_ansi_strip.md)
- [promptfessional util seq](docs/promptfessional_util_seq.md)
- [promptfessional util template](docs/promptfessional_util_template.md)
- [_promptfessional_var_cache](docs/promptfessional_var_cache.md)
### Components
- [cmdtime](docs/component_cmdtime.md)
- [datetime](docs/component_datetime.md)
- [docker](docs/component_docker.md)
- [status](docs/component_status.md)
- [sudo](docs/component_sudo.md)
- [java](docs/component_java.md)
- [jobs](docs/component_jobs.md)
- [path](docs/component_path.md)
- [path_permission](docs/component_path_permission.md)
- [private](docs/component_private.md)
- [venv](docs/component_venv.md)
### Path Decorations
- [git](docs/decoration_git.md)