Skip to main content

Introduction

What is Promptorium?

Showcase

From a high-level perspective, Promptorium is a modular and configurable terminal prompt builder.

On a more technical level, Promptorium is a command-line tool that generates a prompt based on a configuration file. It does so by setting the shell's prompt to the output of a command, without relying on the shell's built-in functionalities. This means that promptorium is almost completely shell agnostic.

Get Started

To start using promptorium, you first need to install it on your system.

note

Make sure you are using a patched Nerdfont for your terminal. We recommend using Fira Code or JetBrains Mono.

Installation

Promptorium provides a common installation script that you can use to install it on your system. To use it, run the following command:

 curl https://raw.githubusercontent.com/Promptorium/promptorium/refs/heads/main/install.bash | bash

The script will install promptorium on your system, automatically detecting your operating system and architecture. Once it's done, restart your terminal and you should see the default promptorium prompt.

Other Methods

Debian/Ubuntu

You can manually add the repository and install promptorium using the following commands:

curl -s https://apt.promptorium.org/gpg-key.public | sudo tee /etc/apt/keyrings/promptorium-gpg.public
echo "deb [arch=amd64 signed-by=/etc/apt/keyrings/promptorium-gpg.public] https://apt.promptorium.org/ unstable main" | sudo tee /etc/apt/sources.list.d/promptorium.list
sudo apt update
sudo apt install promptorium

Or you can download the deb package from the releases page and install it using the following command:

sudo dpkg -i promptorium_[version]-1_[arch].deb

Then run promptorium init, restart your terminal and you should see the default promptorium prompt.

Manual Installation

You can also manually install promptorium by downloading the executable from the releases page and placing it in your $PATH. After that, run the following command:

promptorium init

Configuration

Showcase

The configuration files are located at ~/.config/promptorium/.

Configuration of Promptorium is split in two parts: conf.json and theme.json

You can find out more information on how to configure Promptorium in the configuration documentation.