Other pages in this category: Workflows.
The Jovo Command Line Tools offer the ability to create, prototype, test, and deploy your voice app quickly.
The Jovo CLI (GitHub Repository: jovotech/jovo-cli) is the center of voice app development with the Jovo Framework. With it, you can quickly create new Jovo projects, create language models and deploy them to the voice platforms, and run your voice apps locally for easy prototyping and testing.
To make best use of the Jovo CLI, install it globally via npm:
After successful installation, you should be able to see the jovo 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 out more about technical requirements here: Getting Started > Installation.
If you had the CLI installed before the release of
v1.0, and are running into problems after updating it to the newest version, please try to uninstall it globally before you install it again:
If you run into other problems, please submit an issue here: jovotech/jovo-cli. Thank you!
||Creates a new Jovo project|
||Runs a local development server (webhook)|
||Runs a local development server (webhook)|
||Initializes platform-specific projects in
||Builds platform-specific language model files into
||Downloads an existing platform project into the
These are the basic commands that help you develop Jovo voice apps faster, without interacting with the voice platforms (see platform commands for features that are language model specific).
You can create a Jovo project into a new directory with the following command:
-t: Used to specify which template should be used. Get a list of all the templates below, or on GitHub: jovotech/jovo-templates. Default:
-l: Choose the language of the interaction models in the
/models folder. Default:
-i: This is a shortcut to the
jovo init command. Speed up the creation of your voice application by creating the
app.json file right at the beginning. Requires either
googleAction as argument.
-b: This is a shortcut to the
jovo build command. Speed up the creation of your voice application by building the platform specific files into the
/platforms folder right at the beginning. Requires
-d: This is a shortcut to the
jovo deploy command. Deploy the platform files to their respective developer console. It will deploy to the platform you specified with the
Below is a list of templates that can currently be used with the
jovo new command.
You can find the complete repository on GitHub: jovotech/jovo-templates.
||Trivia game voice app that makes use of states, helper functions, and i18n|
||Sample Alexa Audioplayer Skill that plays a longform audio file with the Audioplayer directive|
||Sample implementation of the Alexa Dialog Interface|
||Sample implementation of the Alexa Skill Events.|
||Sample Google Action media response app that plays longform audio file|
You can use the
jovo run command to start the development server in your
index.js file, and then add the Jovo Webhook as an endpoint to the respective developer consoles.
Learn more here: App Configuration > Server Configuration.
You can also specify the file you want to run:
You can also use other tools like bst proxy to tunnel to your local server.
-p: Defines the port that will be used to run the local development server. Default:
--inspect: Run debugging mode.
If you want to see another integration, please feel free to submit an issue. Thanks!
Here is a list of integrations that work with
||Creates a webhook URL for local testing and integrates with Bespoken Analytics|
You can use the bst proxy to create a webhook URL easily:
The result should look like this:
The URL also comes with logging and analytics capabilities for prototyping and testing.
With this integration, you don't have to manually restart your server with every change you make to the application:
For this, we're using
nodemon, a neat package that monitors your app files and automatically restarts the server.
Platform commands are used to interact with the voice platforms (Amazon Alexa or Google Assistant/Dialogflow). You don't have to use these commands if you just want to maintain the language/interaction models on the respective developer platforms.
See the following tutorials for alternative ways to create language models on the respective developer platforms:
jovo init is the command to initialize a voice platform project to use with the Jovo Framework. This will create or update a file
app.json with all the information needed to later
build the language models.
To create it, use the following command:
app.json file looks like this:
Currently, the platform
nlu (natural language understanding) services are:
2(Jovo supports boths)
endpoint uri is automatically generated and provides a simple solution to run a local webserver for easy debugging. Learn more here: App Configuration > Server Configuration > Webhook. For more options, see below.
-e: This specifies which endpoint you want to include in the
app.json file. Options:
jovo run), and
ngrok (will extract the url if ngrok is running in the background on port
jovo build is the command to create and update the platform specific interaction models using the Jovo model. Using the files in the
/models folder and converting them into files in the
To learn more about Jovo Language Models, take a look at App Configuration > Models.
After the initial
init process, you can either run
build separately for each platform, or just let the CLI fetch the right information from the
-p: If you want to update your platform folders, you can leave it out and it will update the ones listed in
app.json. You can still use it, if you want to only update a specific platform. If you haven't initialized a platform yet, this will trigger the
jovo init command.
-l: Specify the locale, which should be created/updated. Default:
-d: This is a shortcut to the
jovo deploy command. Deploy the platform files to their respective developer console.
jovo get will import an existing Alexa Skill (Skill Information and Interaction Model) or Dialogflow agent (work in progress) into the
To get the Skill from the Amazon developer console, you have to set up ASK CLI first.
-l: Specify the locale, which should be created/updated. Default: all languages available for the Skill.
--list-skills: Shows a list of all available Skill projects for the specific ASK Profile.
-s: Get specific Alexa Skill using the Skill ID.
--project-id: Get a specific Dialogflow agent using the Project ID.
--ask-profile: Specifies which profile set up in ASK CLI should be used to get the information. Default:
-t: Specifies which information should be fetched from the Skill. Arguments:
info (Skill Information),
model (Interaction Model),
jovo deploy is used to upload the platform folders to their respective developer site.
To deploy to the Amazon developer console, you have to set up ASK CLI first.
To deploy a Dialogflow agent you have 2 options:
-p: Specify the platform that should be deployed. Default: Every platform found in the
--project-id: Determine, which project to deploy to.
-l: Specify the locale that should be deployed. Default: Every locale found for each platform.
-t: Specify, what type of information to deploy. Arguments:
info (for Skill or Agent information),
model (for language models),
lambda (for AWS Lambda deployment),
all. Default: all.
Subscribe to our free newsletter to receive updates and tutorials on Jovo and voice interfaces in general.
Any specific questions? Just drop them below. Alternatively, you can also fill out this feedback form. Thank you!