create-shravann
v0.1.10
Published
Spin up the Shravann voice AI platform with one command
Maintainers
Readme
create-shravann
Spin up the Shravann multi-agent voice AI platform with one command.
Usage
npx create-shravannWhat it does
- Checks that Docker is installed
- Creates
~/.shravann/to store configuration and compose files - Auto-generates encryption and JWT secrets
- Pulls and starts core services (Postgres, API, Dashboard)
- Waits for the API health check
- Prints URLs, default login, and next steps
Re-running npx create-shravann is safe — it detects an existing configuration and starts services without overwriting your secrets.
Prerequisites
- Docker Desktop with Compose plugin
- A free LiveKit Cloud account (or self-hosted LiveKit) — configured later through the dashboard
Services started
| Service | URL | | --------- | ---------------------- | | Dashboard | http://localhost:3700 | | API | http://localhost:8484 |
Voice services (worker + session app on :3701) start separately after you configure LiveKit in the dashboard:
cd ~/.shravann && docker compose --profile voice up -dDefault login
| Field | Value | | -------- | -------------------- | | Email | [email protected] | | Password | admin |
You will be prompted to change the password on first login.
Configuration
All config lives in ~/.shravann/:
~/.shravann/
├── .env # secrets and LiveKit credentials
└── docker-compose.yml # service definitionsOverride the install directory with the SHRAVANN_HOME environment variable:
SHRAVANN_HOME=/opt/shravann npx create-shravannLicense
Apache-2.0
