https://github.com/kampanosg/cheeky-prompt.zsh

A cheeky prompt to spice up your terminal 🌶️🐔
https://github.com/kampanosg/cheeky-prompt.zsh

ohmyzsh zsh-theme

Last synced: about 2 months ago
JSON representation

A cheeky prompt to spice up your terminal 🌶️🐔

• Host: GitHub
• URL: https://github.com/kampanosg/cheeky-prompt.zsh
• Owner: kampanosg
• License: mit
• Created: 2023-03-29T08:29:00.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-08-21T14:40:14.000Z (10 months ago)
• Last Synced: 2024-04-11T15:04:58.257Z (about 2 months ago)
• Topics: ohmyzsh, zsh-theme
• Language: Shell
• Homepage: https://nandos.co.uk
• Size: 142 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-zsh-plugins - cheeky - Includes chicken emoji, decorators for current directory, `git` information and current GCP cluster and project. (Themes / ZSH on Windows)

README

        
# cheeky-prompt.zsh

A simple yet effective ~theme~ prompt for your PERiTerm. Developed specifically for my day-to-day use within Nando's as I couldn't find one that covered all my needs. Hopefully, it can spice up your terminal as well 🌶️

The prompt features:

1. Chicken emoji (there isn't a Barci one yet)

1. Current working directory: Useful since most of the work is in the monorepo

1. Git information

1. Current Active GCP Cluster / GCP Project

1. Command input in new line



    



## Installation

### zsh / oh-my-zsh

1. Download the theme in your Downloads folder

```sh

git clone --quiet [email protected]:kampanosg/cheeky-prompt.zsh.git ~/Downloads/cheeky-prompt.zsh

```

2. Move the theme in the `oh-my-zsh` custom themes directory

```sh

cp ~/Downloads/cheeky-prompt.zsh/cheekyprompt.zsh-theme ~/.oh-my-zsh/custom/themes

```

3. Activate the theme in your `.zhrc`

```sh

ZSH_THEME="cheekyprompt"

```

### Config (Optional)

The theme reads an (optional) config file from the following path: `~/.config/cheeky-prompt/cluster`. 

The `cluster` file can hold the name of the cluster that it's currently active. The theme styles the right-hand-side prompt depending on the value. Alternatively, if no config is found, the theme displays the current GCP project.

**Example**

In my `.shrc`, I have an `alias` when I want to connect to any cluster. At the end of the connection sequence, I've added an `echo` command to write the current cluster to the config file. For example:

```sh

alias dev='... && echo "dev" > ~/.config/cheeky-prompt/cluster'

```