Skip to content
nobsprompt
Esc
navigateopen⌘Jpreview
On this page

Get started

Build and install nobsprompt on macOS, then choose its ready-made Zsh prompt or initialize the backend for a custom prompt.

Requirements

  • macOS;
  • Zsh 5.8 or newer;
  • a C11 compiler;
  • Git;
  • Meson 1.1 or newer;
  • Ninja.

Build and install

Build and run the test suite

make test

Install the executable and documentation

make install

The default prefix is ~/.local. The PREFIX make variable can override that location when needed.

Put nbsp on PATH

export PATH="$HOME/.local/bin:$PATH"

Add this before the nbsp initialization line in ~/.zshrc. Omit it when ~/.local/bin is already on PATH.

Choose one integration

eval "$(nbsp init zsh)"
eval "$(nbsp init zsh --detached)"

Put initialization after NVM setup so the active node_version is detected. The first mode initialized in a shell wins.

Restart Zsh

exec zsh

Opening a new terminal has the same effect.

Installed files

With the default prefix, installation places:

File Location
Executable ~/.local/bin/nbsp
Man page ~/.local/share/man/man1/nbsp.1
Markdown documentation ~/.local/share/doc/nobsprompt

Use man nbsp for the terminal reference.

Next step