Installation

Learn about different options to install the Jovo Framework and Jovo CLI.

For a step-by-step introduction, see our quickstart guide.

Introduction

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:

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:

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:

Find a full list of Jovo CLI Commands here.

Create a new Jovo Project

After installing the Jovo CLI, you can create a new project with the following command:

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.

CLI Troubleshooting

If you run into any problems with permissions while installing the Jovo CLI, try to use sudo:

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:

or

Alternatives

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:

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:

Then go into the directory and install the dependencies:

You can find other examples and templates here: Jovo Template Directory.

Upgrading

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 v2 from v1.

Technical Requirements

First, make sure you have the following installed on your computer/development environment:

  • Node.js version 8.10 or later
  • npm (node package manager)

Need help with that? Here are some tutorials to install Node.js and npm: Mac, Windows.

Comments and Questions

Any specific questions? Just drop them below or join the Jovo Community Forum.

Join Our Newsletter

Be the first to get our free tutorials, courses, and other resources for voice app developers.