Getting Started
By Jan König · Last updated Mar 2024
This guide gets you from zero to a running Jovo app in under 5 minutes. By the end, you'll have a working voice/chat application running locally that you can test with the Jovo Debugger.
Prerequisites
- Node.js v16+ — Download here
- npm or yarn package manager
- A terminal (macOS Terminal, Windows PowerShell, or VS Code integrated terminal)
Step 1: Install the Jovo CLI
The Jovo CLI is the main tool for creating, building, and running Jovo projects:
$ npm install -g @jovotech/cli
Verify the installation:
$ jovo --version
# Should output: 4.x.x
Step 2: Create a New Project
$ jovo new my-first-app
$ cd my-first-app
$ npm install
This scaffolds a Jovo v4 project with:
- TypeScript source files in
src/ - A language model in
models/en.json - Platform configurations in
jovo.project.ts
Step 3: Run Locally
$ jovo run
# Local server on port 3000
✓ Webhook: https://webhook.jovo.cloud/xxx
Open the webhook URL in your browser to access the Jovo Debugger. Send test requests, inspect request/response JSON, and trace handler execution — all without needing a physical device.