Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dylanaraps/promptless
🚀 A super fast and extremely minimal shell prompt.
https://github.com/dylanaraps/promptless
bash prompt sh shell zsh
Last synced: 3 months ago
JSON representation
🚀 A super fast and extremely minimal shell prompt.
- Host: GitHub
- URL: https://github.com/dylanaraps/promptless
- Owner: dylanaraps
- License: mit
- Archived: true
- Created: 2019-02-08T18:13:20.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-09-04T17:45:47.000Z (over 3 years ago)
- Last Synced: 2024-05-08T22:55:19.544Z (8 months ago)
- Topics: bash, prompt, sh, shell, zsh
- Language: Shell
- Homepage:
- Size: 54.7 KB
- Stars: 186
- Watchers: 7
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 🚀 promptless
A super fast and extremely minimal shell prompt.
## Features
- Fast
- Minimal
- Lightweight
- POSIX sh (*no external commands*)
- No dependencies
- Works in all shells (*that use `$PS1`*).
## Table of Contents
* [Philosophy](#philosophy)
* [Installation](#installation)
* [Tests](#tests)
* [Hacking](#hacking)
* [Compile time options](#compile-time-options)
## Philosophy
`promptless` follows the [suckless philosophy](https://suckless.org/philosophy/) and is simple by design. The codebase has a focus on elegance and clarity. The prompt is entirely hackable. Unnecessary and unworthy features need to be patched in.
## Installation
**Secure and Safe**
```sh
curl "https://raw.githubusercontent.com/dylanaraps/promptless/master/install.sh" | sh
```
**Webscale**
```sh
npm install promptless
```
**Run with Docker**
```sh
docker build -t promptless .
docker run -it promptless
```
**Distros**
- Arch: `promptless` in the AUR.
**Manual**
```sh
# Inside your .bashrc, .zshrc, etc.
. /path/to/promptless.sh
```
## Tests
Run `./test.sh` to run unit tests on `promptless`.
**NOTE**: The testing framework requires `bash` since it's **ROBUST**.
## Hacking
An array of intelligent patches are available in the `patches/` subdirectory. Patches for color support are not available as just like scroll-back, colors are bloat.
## Compile time options
You can customize the prompt character at compile time.
```sh
make CHAR=">"
```