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
| Method | Use it for | Guide |
|---|---|---|
| Docker | The fastest start on any OS, and container platforms. The image ghcr.io/priompt/priompt is published for amd64 and arm64. | Install with Docker |
| Linux service | A systemd service under its own user. | Install on Linux |
| macOS service | A launchd agent that starts at login. | Install on macOS |
| Windows service | A Windows service managed by NSSM. | Install on Windows |
| From source | go 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:
| Piece | Install it when | How |
|---|---|---|
| Python SDK | Your agents are written in Python. | pip install priompt-sdk |
| Node SDK | Your agents run on Node. | npm install @priompt/client |
promptctl | Authors keep prompts as files in git. | Build from source |
priompt-auth | You need SSO or service accounts. | Build from source |
Ports
| Port | Used by | Expose it |
|---|---|---|
8443 | gRPC API, which clients call. | To your agents. Add TLS first, see Secure a server. |
4222 | Embedded NATS, which carries change events. | Only with -nats-token set. The server refuses a non-loopback NATS address without one. See Secure a server. |
2112 | Prometheus /metrics. | Keep it internal. See Monitoring. |
8444 | priompt-auth, if you run it. | To clients that fetch tokens. See SSO and service accounts. |
Next steps
- Quickstart: try Priompt locally before you install it as a service.
- Production checklist: set what a server needs before it takes real traffic.