mmatongo / toledo

A fast and extremely minimal shell prompt with git tracking.

📦 toledo

A fast and extremely minimal shell prompt with git tracking.

Features

• Fast.
• Minimal.
• Lightweight.
• Works on BASH, ZSH, DASH, YASH. Sorry ASH.
• Works on macOS but you need oh-my-zsh installed.
• POSIX compliant (to a certain extent).

Table of Contents

• What is it?
• Installation
• Prompt Character
• Usage
  • clone_repo usage

What Is It

toledo was an attempt to create a minimal prompt that had git functionality. It's a slew of borrowed ideas that worked well together.

Installation

Manual

git clone https://github.com/mmatongo/toledo.git

# Inside your .bashrc, .zshrc, etc.
. /path/to/toledo

Prompt Character

You can customize the prompt character by modifying the lambda λ sign on line 62 .

export PS1="\$(parse_git_branch) \$(parse_git_dirty) λ "

Usage

The script also includes several useful Git aliases:

gs: git status

gd: git diff

gc: git commit -m

gp: git push

gcb:git checkout -b

gco: git checkout

gf: git fetch

gcl: clone_repo (an alias for git clone)

clone_repo usage

gcl <user_name> <repo_name> [<dir_name>] [-gh | -gl]

• <user_name>: the GitHub or GitLab username that owns the repository.
• <repo_name>: the name of the repository.
• <dir_name> (optional): the name of the directory where the repository will be cloned. If not provided, it will use the name of the repository. -gh or -gl (optional): specify whether to clone from GitHub (-gh) or GitLab (-gl). The default is GitHub.

Screenshots

Initial Screen

Untracked File [?]

Modified File [*]

Renamed File [~]

Deleted File [-]

Switch Branch

Branch is ahead [!]

New file Added [+]

Branch is behind [ˬˬ]

MISC recommendations

As is toledo is pretty functional and can be used as your daily shell prompt, however if you want extra functionality consider using it alongside oh-my-zsh or anything similar.

toledo's Issues

Please add a license file and a screen shot

I'd like to add this to awesome-zsh-plugins, but I prefer to add themes with screen shots in the readme so that users can see what they look like without having to install them.

Also, please add a license file, some people won't use any code that doesn't have an open source license. If you don't have one in mind, https://choosealicense.com is a good resource to help you select an appropriate one.

Thanks!

ASH Compatibility

Currently toledo doesn't play to well with ash.
I haven't done much research into this but I suspect it has something to do with how ash handles shell functions.

TODO

• Make toledo compatible with ash

Readme feedback

Nice job on the prompt, I'm really liking it! I have a few questions that were not answered in the readme. Maybe they could be answered here and then added to the readme if they seem relevant.

1. A single screenshot at the top of the readme that gives an idea of what it looks like would be useful. Interested people would be drawn into reading the rest of the documentation while uninterested people could quickly move on.
2. You show screenshots of what the prompt looks like for different git scenarios (untracked file, modified file, etc) but you don't show how it behaves with multiple git scenarios. What would display if I had a modified file and a renamed file, for example? I guess all relevant icons would display but it's unclear.
3. How does the prompt behave outside of a git repo?

Multiple statuses

For some odd reason multiple statuses of the same kind are showing up.