Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/matchai/spacefish

🚀🐟 The fish shell prompt for astronauts
https://github.com/matchai/spacefish

fish fish-plugin fish-prompt fish-shell fish-theme fisher oh-my-fish oh-my-fish-plugin omf-theme spacefish spaceship

Last synced: 15 days ago
JSON representation

🚀🐟 The fish shell prompt for astronauts

Host: GitHub
URL: https://github.com/matchai/spacefish
Owner: matchai
License: mit
Archived: true
Created: 2018-02-01T04:33:45.000Z (almost 7 years ago)
Default Branch: master
Last Pushed: 2021-05-05T12:14:53.000Z (over 3 years ago)
Last Synced: 2024-08-01T15:16:33.072Z (3 months ago)
Topics: fish, fish-plugin, fish-prompt, fish-shell, fish-theme, fisher, oh-my-fish, oh-my-fish-plugin, omf-theme, spacefish, spaceship
Language: Shell
Homepage: https://spacefish.matchai.dev
Size: 5.27 MB
Stars: 960
Watchers: 14
Forks: 78
Open Issues: 23
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

        


  

    

  



  

    

  

  


  
 Spacefish 🚀🐟 






  Fish Shell prompt for Astronauts.





  

    

  

  

  

  

  

    

  





  

    Website |

    Install |

    Features |

    Options |

    API

  





  _{Built with ❤︎ by

  Matan Kushner and

  contributors}

  


  _{A port of Spaceship ZSH by

  Denys Dovhan}






Spacefish is a minimalistic, powerful and extremely customizable Fish Shell prompt. It combines everything you may need for convenient work, without unnecessary complications, like a real spacefish.



  

_{Vist Troubleshooting for instructions to recreate this terminal setup.}

## Features

* Clever hostname and username displaying.

* Indicator if user is root.

* Prompt character turns red if the last command exits with non-zero code.

* Current Git branch and rich repo status:

  * `?` — untracked changes;

  * `+` — uncommitted changes in the index;

  * `!` — unstaged changes;

  * `»` — renamed files;

  * `✘` — deleted files;

  * `$` — stashed changes;

  * `=` — unmerged changes;

  * `⇡` — ahead of remote branch;

  * `⇣` — behind of remote branch;

  * `⇕` — diverged changes.

* Indicator for jobs in the background (`✦`).

* Current Node.js version, through nvm/nodenv/n (`⬢`).

* Current Docker version and connected machine (`🐳`).

* Current Ruby version, through rvm/rbenv/chruby/asdf (`💎`).

* Current Go version (`🐹`).

* Current PHP version (`🐘`).

* Current Rust version (`𝗥`).

* Current version of Haskell GHC Compiler, defined in stack.yaml file (`λ`).

* Current Julia version (`ஃ`).

* Current Amazon Web Services (AWS) profile (`☁️`) ([Using named profiles](http://docs.aws.amazon.com/cli/latest/userguide/cli-multiple-profiles.html)).

* Current Python virtualenv.

* Current Conda version (`🅒`).

* Current Elixir Version (`💧`).

* Current Python pyenv (`🐍`).

* Current .NET SDK version, through dotnet-cli (`.NET`).

* Current Kubectl context (`☸️`).

* Package version, if there is a package in current directory (`📦`).

* Current battery level and status:

  * `⇡` - charging;

  * `⇣` - discharging;

  * `•` - fully charged.

* Current Vi-mode mode.

* Optional exit-code of last command.

* Optional time stamps 12/24hr in format.

* Execution time of the last command if it exceeds 5 seconds.

Want more features? Please [open an issue](https://github.com/matchai/spacefish/issues/new?template=Feature_request.md) or send pull request!

## Requirements

To get spacefish working correctly, you will need:

* [`fish`][fish] (v2.7.0 or newer)

* [Powerline Font](https://github.com/powerline/fonts) must be installed and enabled in your terminal.

## Installation

### [Fisher](https://github.com/jorgebucaran/fisher)

```fish

$ fisher install matchai/spacefish

```

### [Oh My Fish!](https://github.com/oh-my-fish/oh-my-fish)

```fish

$ omf install spacefish

```

## Customization

Spacefish works really well out of the box, but you can customize your fish to your heart's content!

* [**Options**](./docs/Options.md) — Tweak section's behavior with tons of options.

You have the ability to customize or disable specific elements of Spacefish. All options must be overridden in your `config.fish`.

## Troubleshooting

Having issues? Take a look at our [Troubleshooting](./docs/Troubleshooting.md) page.

Still struggling? Please [file an issue](https://github.com/matchai/spacefish/issues/new?template=Support_question.md), describe your problem, and we will gladly help you.

## Contributors

Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):

  

    
_{Matan Kushner}
🐛 💻 📖 👀 ⚠️ 🔧 🎨

    
_{Tiffany Le-Nguyen}
🐛 💻 📖 👀 ⚠️

    
_Snuggle
🐛 💻 📖 👀 ⚠️

    
_{Jaskaran Bindra}
💻 📖 ⚠️

    
_{Konstantin Labun}
💻 📖 ⚠️

    
_{Kyle Holzinger}
💻 📖

    
_{Salmanul Farzy}
💻 👀

  

  

    
_owais
💻 📖 ⚠️

    
_{Samantha Enders}
💻 📖 ⚠️

    
_{Evan Relf}
💻 📖

    
_{Jason Etcovitch}
💻 📖

    
_hrvoj3e
🐛 💻

    
_{Michael Newman}
🐛 💻 📖 ⚠️

    
_Konrad
🐛

  

  

    
_{Will Neville}
🐛

    
_{Daniel Trautmann}
💻

    
_{Jonas Öhlander}
🐛

    
_lindsay
📖

    
_Brad
💻

    
_{Nam Nguyen}
💻

    
_{Austin Ziegler}
👀

  

  

    
_{Konstantinos Koukopoulos}
💻 ⚠️

  

This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!

## License

MIT © [Matan Kushner](http://matchai.dev)

[spaceship]: https://github.com/denysdovhan/spaceship-prompt

[fish]: https://fishshell.com

[zsh]: http://zsh.org