Skip to main content

Install Priompt

Use Docker unless you need a native service; then follow the guide for your OS. Priompt is one static Go binary, with SQLite built in, so there's no runtime or database to install first.

Choose a method​

MethodUse it forGuide
DockerThe fastest start on any OS, and container platforms. The image ghcr.io/priompt/priompt is published for amd64 and arm64.Install with Docker
Linux serviceA systemd service under its own user.Install on Linux
macOS serviceA launchd agent that starts at login.Install on macOS
Windows serviceA Windows service managed by NSSM.Install on Windows
From sourcego install on any OS, or a build from a clone.Build from source

The Linux, macOS, and Windows guides build the binary with go install.

No prebuilt binaries yet

Priompt doesn't publish downloadable binaries yet. Use Docker or go install. See Status and roadmap.

What else to install​

You only need the server. Install the rest when you need it:

PieceInstall it whenHow
Python SDKYour agents are written in Python.pip install priompt-sdk
Node SDKYour agents run on Node.npm install @priompt/client
promptctlAuthors keep prompts as files in git.Build from source
priompt-authYou need SSO or service accounts.Build from source

Ports​

PortUsed byExpose it
8443gRPC API, which clients call.To your agents. Add TLS first, see Secure a server.
4222Embedded NATS, which carries change events.Only with -nats-token set. The server refuses a non-loopback NATS address without one. See Secure a server.
2112Prometheus /metrics.Keep it internal. See Monitoring.
8444priompt-auth, if you run it.To clients that fetch tokens. See SSO and service accounts.

Next steps​