https://github.com/ryooooooga/croque

Fast and customizable shell prompt
https://github.com/ryooooooga/croque

fish fish-prompt shell-prompt zsh zsh-prompt zsh-theme

Last synced: 3 months ago
JSON representation

Fast and customizable shell prompt

• Host: GitHub
• URL: https://github.com/ryooooooga/croque
• Owner: Ryooooooga
• License: other
• Created: 2023-02-12T10:30:25.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-13T23:41:56.000Z (7 months ago)
• Last Synced: 2025-02-02T04:11:16.383Z (3 months ago)
• Topics: fish, fish-prompt, shell-prompt, zsh, zsh-prompt, zsh-theme
• Language: Rust
• Homepage:
• Size: 518 KB
• Stars: 9
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Croque

[![](https://github.com/Ryooooooga/croque/workflows/Build/badge.svg)](https://github.com/Ryooooooga/croque/actions)

[![](https://badgen.net/crates/v/croque)](https://crates.io/crates/croque)

Fast and customizable shell prompt.

![](docs/screenshot.png)

## Optional Requirements

- [gh](https://github.com/cli/cli)

- [glab](https://docs.gitlab.com/ee/integration/glab)

## Installation

### From source

```sh

cargo install croque

```

### From Homebrew

```sh

brew install ryooooooga/tap/croque

```

### From precompiled binary

[releases](https://github.com/Ryooooooga/croque/releases)

### Bash

```bash

# ~/.bashrc

eval "$(croque init bash)"

```

### Zsh

```zsh

# ~/.zshrc

eval "$(croque init zsh)"

```

#### Using [Zinit](https://github.com/zdharma-continuum/zinit)

```zsh

# .zshrc

zinit light-mode from'gh-r' as'program' for \

    atclone'./croque init zsh >croque.zsh; zcompile croque.zsh' atpull'%atclone' \

    src'croque.zsh' \

    @'Ryooooooga/croque'

```

### Fish

```fish

# ~/.config/fish/config.fish

croque init fish | source

```

## Configuration

```sh

$ croque config > ~/.config/croque/config.yaml

```