Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/hadenlabs/zsh-starship

dotfiles linux osx peru plugin starship zsh

Last synced: 28 days ago
JSON representation

Host: GitHub
URL: https://github.com/hadenlabs/zsh-starship
Owner: hadenlabs
License: lgpl-3.0
Created: 2020-01-09T09:24:07.000Z (almost 5 years ago)
Default Branch: main
Last Pushed: 2023-07-25T21:16:58.000Z (over 1 year ago)
Last Synced: 2024-04-16T01:33:18.797Z (9 months ago)
Topics: dotfiles, linux, osx, peru, plugin, starship, zsh
Language: Shell
Homepage:
Size: 623 KB
Stars: 8
Watchers: 3
Forks: 1
Open Issues: 6
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: docs/contributing.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: docs/code_of_conduct.md

Awesome Lists containing this project

README

        

[![Latest Release](https://img.shields.io/github/release/hadenlabs/zsh-starship)](https://github.com/hadenlabs/zsh-starship/releases) [![Lint](https://img.shields.io/github/workflow/status/hadenlabs/zsh-starship/lint-code)](https://github.com/hadenlabs/zsh-starship/actions?workflow=lint-code) [![CI](https://img.shields.io/github/workflow/status/hadenlabs/zsh-starship/ci)](https://github.com/hadenlabs/zsh-starship/actions?workflow=ci) [![Test](https://img.shields.io/github/workflow/status/hadenlabs/zsh-starship/test)](https://github.com/hadenlabs/zsh-starship/actions?workflow=test) [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit) [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow)](https://conventionalcommits.org) [![KeepAChangelog](https://img.shields.io/badge/changelog-Keep%20a%20Changelog%20v1.0.0-orange)](https://keepachangelog.com)

# zsh-starship

zsh-starship for project

## Requirements

This is a list of plugins that need to be installed previously to enjoy all the goodies of this configuration:

- [gomplate](https://github.com/hairyhenderson/gomplate)

- [python](https://www.python.org)

- [taskfile](https://github.com/go-task/task)

## Installation

### [oh-my-zsh](https://github.com/ohmyzsh/ohmyzsh) users

If you're using [oh-my-zsh](https://github.com/ohmyzsh/ohmyzsh), install this plugin by doing the following:

1.  Go to your oh-my-zsh custom plugins directory -`cd ~/.oh-my-zsh/custom/plugins`

2.  Clone the plugin `bash git clone https://github.com/hadenlabs/zsh-starship`bash

3.  Edit your `.zshrc` and add `plugins=( ... zsh-starship )` to your list of plugins

4.  Open a new terminal and enjoy!

    

    

    

    

    

    

    

    

    

### [antigen](https://github.com/zsh-users/antigen) users

If you're using [Antigen](https://github.com/zsh-users/antigen), install this plugin by doing the following:

1.  Add `antigen bundle hadenlabs/zsh-starship` to your `.zshrc` where you're adding your other plugins.

2.  Either open a new terminal to force zsh to load the new plugin, or run `antigen bundle hadenlabs/zsh-starship` in a running zsh session.

3.  Enjoy!

    

    

    

    

    

    

    

    

### [antibody](https://github.com/getantibody/antibody) users

If you're using [Antibody](https://github.com/getantibody/antibody), install this plugin by doing the following:

1.  Add :

```{.sourceCode .bash}

antibody bundle hadenlabs/zsh-starship

```

to your `.zshrc` where you're adding your other plugins.

2.  Either open a new terminal to force zsh to load the new plugin, or run `antibody bundle hadenlabs/zsh-starship` in a running zsh session.

3.  Enjoy!

## Usage

# How to use this project

## Replace name project to New Project

```bash

agr 'zsh-starship' 'new-project'

```

## Examples

### Common

## Functions

zsh starship includes a small utility `starship`.

#### `starship::post_install`

Synchronizes and install configurations.

#### `starship::sync`

Synchronizes the configurations that are in `conf/starship.conf`

#### `starship::install`

Install starship

## Help

**Got a question?**

File a GitHub [issue](https://github.com/hadenlabs/zsh-starship/issues).

## Contributing

See [Contributing](./docs/contributing.md).

## Module Versioning

This Module follows the principles of [Semantic Versioning (SemVer)](https://semver.org/).

Using the given version number of `MAJOR.MINOR.PATCH`, we apply the following constructs:

1. Use the `MAJOR` version for incompatible changes.

1. Use the `MINOR` version when adding functionality in a backwards compatible manner.

1. Use the `PATCH` version when introducing backwards compatible bug fixes.

### Backwards compatibility in `0.0.z` and `0.y.z` version

- In the context of initial development, backwards compatibility in versions `0.0.z` is **not guaranteed** when `z` is increased. (Initial development)

- In the context of pre-release, backwards compatibility in versions `0.y.z` is **not guaranteed** when `y` is increased. (Pre-release)

## Copyright

Copyright © 2018-2023 [Hadenlabs](https://hadenlabs.com)

## Trademarks

All other trademarks referenced herein are the property of their respective owners.

## License

The code and styles are licensed under the LGPL-3.0 license [See project license.](LICENSE).

## Don't forget to 🌟 Star 🌟 the repo if you like zsh-starship

[Your feedback is appreciated](https://github.com/hadenlabs/zsh-starship/issues)