https://github.com/btreemap/promptpipe
PromptPipe is a Go-based messaging service that delivers adaptive-intervention prompts over WhatsApp using the whatsmeow library.
https://github.com/btreemap/promptpipe
Last synced: 17 days ago
JSON representation
PromptPipe is a Go-based messaging service that delivers adaptive-intervention prompts over WhatsApp using the whatsmeow library.
- Host: GitHub
- URL: https://github.com/btreemap/promptpipe
- Owner: BTreeMap
- License: mit
- Created: 2025-05-17T01:08:30.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2026-04-26T16:48:25.000Z (about 2 months ago)
- Last Synced: 2026-04-26T18:25:54.315Z (about 2 months ago)
- Language: Go
- Homepage:
- Size: 1.29 MB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Agents: AGENTS.md
Awesome Lists containing this project
README
# PromptPipe
PromptPipe is a Go-based WhatsApp messaging service built on the [whatsmeow](https://github.com/tulir/whatsmeow) client. It exposes a REST API to send and schedule prompts, track receipts and responses, and run a stateful conversation flow (intake + feedback). OpenAI-backed GenAI features are optional.
## Table of Contents
- [Overview](#overview)
- [Quickstart](#quickstart)
- [Configuration](#configuration)
- [API Reference](#api-reference)
- [Conversation Flow](#conversation-flow)
- [Storage](#storage)
- [Development](#development)
- [Docs Index](#docs-index)
- [License](#license)
## Overview
Key capabilities:
- Send and schedule prompts (static, genai, branch, conversation, custom)
- WhatsApp integration via whatsmeow
- Conversation flow with intake and feedback modules
- Auto-enrollment of new participants (optional)
- Receipt/response tracking and timer introspection
- SQLite or PostgreSQL for application data
## Quickstart
```bash
# Build
make build
# Run (loads .env if present)
./build/promptpipe
```
Optional GenAI configuration:
```bash
export OPENAI_API_KEY="your-openai-key"
./build/promptpipe
```
PromptPipe searches for `.env` files in `./.env`, `../.env`, and `../../.env`.
## Configuration
See [docs/configuration.md](docs/configuration.md) for environment variables, CLI flags, defaults, and precedence rules.
## API Reference
See [docs/api.md](docs/api.md) for endpoints, request/response schemas, and examples. API test scripts live in [test-scripts/](test-scripts/README.md).
## Conversation Flow
See [docs/conversation.md](docs/conversation.md) for the current flow summary and [docs/conversation-flow.md](docs/conversation-flow.md) for detailed behavior.
## Storage
See [docs/storage.md](docs/storage.md) for database layout and persistence details.
## Development
See [docs/development.md](docs/development.md) for build/test instructions.
## Docs Index
Current implementation references:
- [Configuration](docs/configuration.md)
- [API Reference](docs/api.md)
- [Flow Generators](docs/flows.md)
- [Conversation Flow (summary)](docs/conversation.md)
- [Conversation Flow (detailed)](docs/conversation-flow.md)
- [Storage](docs/storage.md)
- [Debug Mode](docs/debug-mode.md)
- [Auto-enrollment](docs/auto-enrollment-feature.md)
- [Intensity adjustment](docs/intensity-adjustment-feature.md)
- [State recovery](docs/state-persistence-recovery.md)
- [Troubleshooting](docs/troubleshooting.md)
Legacy or historical design docs (kept for reference):
- [Beginner guide](docs/beginner-guide.md)
- [Onboarding guide](docs/onboarding.md)
- [Conversation flow architecture](docs/conversation-flow-architecture.md)
- [Conversation flow comprehensive](docs/conversation-flow-comprehensive.md)
Python/LangChain subproject: the `python/langchain` directory is experimental and **not integrated** with the Go service. Its documentation is marked accordingly.
## License
MIT License. See [LICENSE](LICENSE).