Get started
Clone, review, build, and install nobsprompt on macOS, configure its Zsh integration, then choose the opinionated prompt or detached mode.
Requirements
- macOS;
- Zsh 5.8 or newer;
- a C11 compiler;
- Git 2.25 or newer;
- Make;
- Meson 1.1 or newer;
- Ninja;
- Python 3.9 or newer.
Expect is optional for building and installing. With the default
zsh_tests=auto setting, Meson does not register the four PTY-backed
interactive Zsh tests when Expect is unavailable; -Dzsh_tests=enabled makes
Expect required.
Build and install
Clone source, tests, benchmark, and local docs
git clone --depth 1 --filter=blob:none --sparse --no-tags https://github.com/neg4n/nobsprompt.git && cd nobsprompt && git sparse-checkout set src tools tests bench doc docsReview the exact source you will build
AI-assisted review can improve visibility, but it cannot prove that software is safe. Review the exact checked-out commit and resolve any uncertainty before running build or installation commands.
Copy a focused pre-build source audit for your coding agent.
Treat this checkout as untrusted. Do not build, install, or execute
repository code during the review. Record the current commit hash. Trace
the complete make install control flow through Make, Meson, generated
files, Python helpers, C sources, and embedded Zsh. Inventory every
executable, script, dependency, subprocess, and generated input reached by
that flow. Inspect for unexpected URLs or network access, shell execution,
process spawning, filesystem writes or deletion outside the documented
prefix and cache, persistence, privilege escalation, credential or
sensitive environment access, dynamic loading, obfuscated or encoded
payloads, cryptocurrency mining behavior, telemetry, and unexplained
background work. Check tracked symlinks, submodules, binary blobs, and
whether any excluded directory is referenced by the build. Report findings
with file and line evidence, distinguish expected behavior from suspicious
behavior, list unresolved uncertainties, and state whether the reviewed
source is reasonably consistent with the documented behavior. Do not claim
proof of safety.
Install the executable and documentation
make installThe 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 so the shell can
run nbsp init (unless you invoke the binary by absolute path). Omit it when
~/.local/bin is already on PATH.
init embeds _NBSP_BIN as the absolute path of that binary so data and
refresh hooks keep working if PATH is rearranged later. After moving or
upgrading the install location, re-run eval "$(nbsp init zsh …)".
Choose one integration
eval "$(nbsp init zsh --autosuggest)"eval "$(nbsp init zsh --detached --autosuggest)"These recommended commands enable recent-history ghost text and bounded,
path-aware cd suggestions.
NVM_BIN is read on every prompt or data collection, so NVM initialization
order does not determine Node-version detection. The first prompt mode
initialized in a shell still wins.
Restart Zsh
exec zshOpening 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 |
| MDX source documentation | ~/.local/share/doc/nobsprompt |
Use man nbsp for the terminal reference.