Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mmatongo/toledo
A fast and extremely minimal shell prompt with git tracking.
https://github.com/mmatongo/toledo
bash bashrc git github minimal prompt pure shell shell-prompt shell-theme terminal theme toledo zsh zshrc
Last synced: about 1 month ago
JSON representation
A fast and extremely minimal shell prompt with git tracking.
- Host: GitHub
- URL: https://github.com/mmatongo/toledo
- Owner: mmatongo
- License: mit
- Archived: true
- Created: 2020-05-03T01:10:48.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-01T16:26:01.000Z (about 1 year ago)
- Last Synced: 2024-01-25T23:11:23.774Z (4 months ago)
- Topics: bash, bashrc, git, github, minimal, prompt, pure, shell, shell-prompt, shell-theme, terminal, theme, toledo, zsh, zshrc
- Homepage:
- Size: 307 KB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Lists
- awesome-zsh-plugins - toledo - Quick minimalist theme with `git` status decorations. Works with `zsh`, `bash`, `dash` and `yash`. (Themes / ZSH on Windows)
- fucking-awesome-zsh-plugins - toledo - Quick minimalist theme with `git` status decorations. Works with `zsh`, `bash`, `dash` and `yash`. (Themes / ZSH on Windows)
- awesome-zsh-plugins - toledo - Quick minimalist theme with `git` status decorations. (Themes / ZSH on Windows)
README
# :package: 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?](#What-Is-It)
- [Installation](#installation)
- [Prompt Character](#Prompt-Character)
- [Usage](#usage)
- [`clone_repo` 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**
```sh
git clone https://github.com/mmatongo/toledo.git
```
```sh
# Inside your .bashrc, .zshrc, etc.
. /path/to/toledo
```
## Prompt Character
You can customize the prompt character by modifying the lambda `λ` sign on line [62](https://github.com/mmatongo/toledo/blob/master/toledo#L62) .
```sh
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
```sh
gcl [] [-gh | -gl]
```
- : the GitHub or GitLab username that owns the repository.
- : the name of the repository.
- (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.