Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spaceship-prompt/spaceship-section
😍 Custom section template for Spaceship prompt
https://github.com/spaceship-prompt/spaceship-section
prompt shell shell-prompt shell-theme spaceship spaceship-prompt terminal zsh
Last synced: 2 months ago
JSON representation
😍 Custom section template for Spaceship prompt
- Host: GitHub
- URL: https://github.com/spaceship-prompt/spaceship-section
- Owner: spaceship-prompt
- License: mit
- Created: 2022-05-09T18:16:33.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-04T18:07:15.000Z (about 2 years ago)
- Last Synced: 2024-05-22T17:24:39.267Z (8 months ago)
- Topics: prompt, shell, shell-prompt, shell-theme, spaceship, spaceship-prompt, terminal, zsh
- Language: Shell
- Homepage:
- Size: 39.1 KB
- Stars: 13
- Watchers: 4
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
😍 + 🚀
Spaceship Section
A Foobar section for Spaceship prompt
Current Foobar version, through foobar (`😍`).
## Installing
You need to source this plugin somewhere in your dotfiles. Here's how to do it with some popular tools:
### [Oh-My-Zsh]
Execute this command to clone this repo into Oh-My-Zsh plugin's folder:
```zsh
git clone https://github.com/spaceship-prompt/spaceship-section.git $ZSH_CUSTOM/plugins/spaceship-section
```
Include `spaceship-section` in Oh-My-Zsh plugins list:
```zsh
plugins=($plugins spaceship-section)
```
### [zplug]
```zsh
zplug "spaceship-prompt/spaceship-section"
```
### [antigen]
```zsh
antigen bundle "spaceship-prompt/spaceship-section"
```
### [antibody]
```zsh
antibody bundle "spaceship-prompt/spaceship-section"
```
### [zinit]
```zsh
zinit light "spaceship-prompt/spaceship-section"
```
### [zgen]
```zsh
zgen load "spaceship-prompt/spaceship-section"
```
### [sheldon]
```toml
[plugins.spaceship-section]
github = "spaceship-prompt/spaceship-section"
```
### Manual
If none of the above methods works for you, you can install Spaceship manually.
1. Clone this repo somewhere, for example to `$HOME/.zsh/spaceship-section`.
2. Source this section in your `~/.zshrc`.
### Example
```zsh
mkdir -p "$HOME/.zsh"
git clone --depth=1 https://github.com/spaceship-prompt/spaceship-section.git "$HOME/.zsh/spaceship-section"
```
For initializing prompt system add this to your `.zshrc`:
```zsh title=".zshrc"
source "~/.zsh/spaceship-section/spaceship-section.plugin.zsh"
```
## Usage
After installing, add the following line to your `.zshrc` in order to include Ember section in the prompt:
```zsh
spaceship add foobar
```
## Options
This section is shown only in directories within a foobar context.
| Variable | Default | Meaning |
| :------------------------- | :--------------------------------: | ------------------------------------ |
| `SPACESHIP_FOOBAR_SHOW` | `true` | Show current section |
| `SPACESHIP_FOOBAR_PREFIX` | `$SPACESHIP_PROMPT_DEFAULT_PREFIX` | Prefix before section |
| `SPACESHIP_FOOBAR_SUFFIX` | `$SPACESHIP_PROMPT_DEFAULT_SUFFIX` | Suffix after section |
| `SPACESHIP_FOOBAR_SYMBOL` | `😍·` | Character to be shown before version |
| `SPACESHIP_FOOBAR_COLOR` | `yellow` | Color of section |
## Contributing
First, thanks for your interest in contributing!
Contribute to this repo by submitting a pull request. Please use [conventional commits](https://www.conventionalcommits.org/), since this project adheres to [semver](https://semver.org/) and is automatically released via [semantic-release](https://github.com/semantic-release/semantic-release).
## License
MIT © [Name Surname](http://yourwebsite.com)
[Oh-My-Zsh]: https://ohmyz.sh/
[zplug]: https://github.com/zplug/zplug
[antigen]: https://antigen.sharats.me/
[antibody]: https://getantibody.github.io/
[zinit]: https://github.com/zdharma/zinit
[zgen]: https://github.com/tarjoilija/zgen
[sheldon]: https://sheldon.cli.rs/