Jovo CLI

Learn more about the Jovo CLI, the command line interface that lets you create new Jovo projects, run them locally, and deploy them to various platforms.


The Jovo CLI allows you to speed up the development process of voice and chat apps with the Jovo Framework. Both individual developers as well as teams use the CLI to develop and test Jovo apps more efficiently.

With the Jovo CLI, you can do many things, including:

Learn how to install the Jovo CLI in the installation section. In the configuration section, we'll take a look at configurations and plugins that can be added to the CLI.

After that, we'll take a look at all CLI commands and ways to extend the Jovo CLI. For bugfixes, take a look at the local setup section.


You can install the new Jovo CLI like this:

$ npm install -g @jovotech/cli

After successful installation, you should be able to see the Jovo CLI menu by typing the following into your command line:

$ jovo


There are two types of Jovo CLI configurations:

Project Config

For each project, you can configure the Jovo CLI and its plugins in the jovo.project.js project configuration file in the root of a Jovo project:

const { ProjectConfig } = require('@jovotech/cli');
// ...

const project = new ProjectConfig({
  endpoint: '${JOVO_WEBHOOK_URL}',
  plugins: [
    // Add Jovo CLI plugins here

Learn more about project configuration here.

User Config

There is also a global config file for the Jovo CLI that gets saved into a .jovo folder in your root user directory. This is called UserConfig.

It includes the following configurations:

  webhook!: {
    uuid: string;
  cli!: {
    plugins: string[];
    presets: Preset[];
    omitHints?: boolean;
  timeLastUpdateMessage?: string;
  • webhook: Configuration for your Jovo Webhook URL.
  • cli: This includes global plugins (all installed CLI commands), presets (that are used and added during the new command), and a flag omitHints that can be modified to suppress the display of hints when using Jovo CLI commands.
  • timeLastUpdateMessage: This is an internal value that tracks when was the last time the CLI checked for potential updates.

Here is an example config file:

  "webhook": {
    "uuid": "<your-webhook-id>"
  "cli": {
    "plugins": [
    "presets": [
        "name": "default",
        "projectName": "helloworld",
        "locales": ["en"],
        "platforms": [],
        "language": "typescript"
  "timeLastUpdateMessage": "2022-02-16T16:27:39.960Z"

As you can see in the plugins section in the example above, all global CLI commands are referenced in the user config. If you run into command not found errors, it's possible that the CLI can't access the user config.

If you need to access local versions of the commands, for example in an npm script or CI environment, you can add them to the project configuration like this:

const { ProjectConfig } = require('@jovotech/cli');
const { BuildCommand } = require('@jovotech/cli-command-build');
// ...

const project = new ProjectConfig({
  endpoint: '${JOVO_WEBHOOK_URL}',
  plugins: [
    new BuildCommand(),
    // ...


Learn more about all global Jovo CLI commands:

  • new: Create a new Jovo project
  • run: Start the local development server
  • build: Create platform-specific project files
  • deploy: Deploy to various platforms and services
  • get: Sync your local files with platform files
  • update: Update Jovo packages in your project

You can also add your own commands. Learn more in the extend the Jovo CLI section.


Currently, these integrations are available for the Jovo CLI:

  • Amazon Alexa: Build and deploy project files to the Alexa Developer Console
  • Google Assistant: Build and deploy project files to the Actions on Google Console
  • Serverless: Deploy your Jovo code using the Serverless Framework

Extend the Jovo CLI

There are many use cases where it could make sense to customize the Jovo CLI to fit your workflow. For example, it could be necessary to call an API to get some external data that is relevant for the language model in the build process. Or you might want to build your own deployment integration.

There are two ways how you can extend the Jovo CLI:

  • CLI hooks: Hook into existing CLI commands. For example, call an API and retrieve data as part of the build command.
  • CLI plugins: Create your own plugins that could hook into commands, or even create commands on their own.

Local Setup

If you want to extend the Jovo CLI functionality, it should be sufficient to follow the steps mentioned above. However, if you encounter any issues or want to dig deeper into core functionality, it might be useful to set up the CLI for local development.

To get started, clone the CLI repository to your workspace and run the local setup script:

# Clone CLI repository
$ git clone

# Go to the CLI directory
$ cd jovo-cli

# Run the local setup script
$ npm run setup:dev

This will install all necessary dependencies and link the local binary to jovodev. This allows you to apply and test changes in the code directly by recompiling the corresponding module and running jovodev.

$ jovodev

For example, if you need to make some changes to the build:platform command, you need to go into jovo-cli/commands/command-build, adjust the code to your needs and recompile it using npm run build, or npm run build:watch if you want to recompile on code changes automatically (similar to nodemon). When running the command using jovodev, you should see your changes implemented:

$ jovodev build:platform