Skip to main content

Installation

Priompt is one static Go binary: no runtime, no CGO, and no database to install (SQLite is built in). There are two ways to get it:

MethodGood forStatus
DockerThe fastest start on any OS, and containerized productionImage name <docker-image> is a placeholder until the first release. docker compose up --build from source works today.
From sourceEvery OS, todayWorks now. Needs Go 1.25+ and git.
Prebuilt binariesDownloading a single fileNot published yet

Then follow the guide for your OS to run it as a proper background service:

  • Linux: systemd unit, dedicated user, firewall
  • macOS: launchd agent, Apple Silicon and Intel
  • Windows: PowerShell setup, running as a Windows service

What gets installed where

PieceRequired?Install
priompt serveryesthis section
Python SDKif your agents are Pythonpip install <pypi-package>
JS SDKif your agents are Nodenpm i <npm-package>
promptctlif authors keep prompts in gitbuild from source
priompt-authif you need SSO or service accountsbuild from source

Ports

PortWhatExpose?
8443gRPC API (what clients talk to)Yes, to your agents
4222Embedded NATS (change notifications)Only with -nats-token set. The server refuses a non-loopback bind without one.
2112Prometheus /metricsKeep internal
8444priompt-auth (if used)To clients that fetch tokens