Learn about different options to install the Jovo Framework and Jovo CLI.
- Jovo CLI Installation
- Technical Requirements
For a step-by-step introduction, see our quickstart guide.
Jovo is an open-source framework based on Typescript which can be used with Node.js. If you run into any problems while installing it, please let us know in the comments, create an issue on GitHub, or join our Developer Slack community.
There are several ways how you can install Jovo:
- Install the Jovo CLI (recommended way in our quickstart guide)
- Download the jovo-framework npm package
- Cole a Jovo Sample Voice App
You can also find tutorials and courses here: jovo.tech/learn. Happy coding!
Jovo CLI Installation
To use Jovo in the best and most efficient way, install the Jovo CLI globally with:
$ npm install -g jovo-cli
After successful installation, you should be able to see the Jovo CLI menu by just typing the following into your command line:
You can check the version number (and compare it to the jovo-cli npm package version) with this command:
$ jovo -v
Create a new Jovo Project
After installing the Jovo CLI, you can create a new project with the following command:
$ jovo new <directory>
This will download a new Jovo "Hello World" project into a new
<directory> folder and install all necessary dependencies.
For next steps with the Jovo CLI, please see our quickstart guide.
If you run into any problems with permissions while installing the Jovo CLI, try to use
$ sudo npm install -g jovo-cli
If you had the CLI installed before the release of Jovo Framework v1 or v2, and are running into problems after updating it to the newest version, please try to uninstall it globally before you install it again:
$ npm remove -g jovo-cli
$ sudo npm remove -g jovo-cli
For other examples of getting started with the Jovo Framework without using the Jovo CLI, please see below:
jovo-framework npm package
If you want to use the Jovo Framework as a dependency in an already existing project, you can use npm to save it to your package.json:
$ npm install --save jovo-framework
You can find the npm package here: npmjs.com/package/jovo-framework.
Jovo Sample Voice App
You can find a sample project for a simple voice app with the Jovo framework on GitHub: jovotech/jovo-sample-voice-app-nodejs.
You can clone it like this:
$ git clone https://github.com/jovotech/jovo-sample-voice-app-nodejs.git
Then go into the directory and install the dependencies:
$ npm install
You can find other examples and templates here: Jovo Template Directory.
If you want to upgrade your existing voice app that uses Jovo, take a look at the following guides:
- Upgrading: General documentation about updating both the Jovo Framework and CLI.
- v1 Migration: Learn how to migrate to Jovo
First, make sure you have the following installed on your computer/development environment:
- Node.js version 8.10 or later
- npm (node package manager)