dialogflow-cx-cli

README

CX CLI

Dialogflow utility to test your Dialogflow CX Project

• CX CLI
  • Installation
    • Homebrew
• Usage
  • Profile NLU Test Suites
  • CICD for your Dialogflow CX environments
  • Text-to-Speech

Installation

You can download the latest release from here

Homebrew

If you use the package manager Homebrew, you can install this utility following these steps:

1. Add my Hombre tab:

brew tap xavidop/tap git@github.com:xavidop/homebrew-tap.git
brew update

1. Install the CLI:

brew install cxcli

Usage

Usage:
  cxcli [flags]
  cxcli [command]

Available Commands:
  cicd        Actions on CICD testings
  completion  Generate the autocompletion script for the specified shell
  help        Help about any command
  profile-nlu Actions on testing
  tts         Actions on text-to-speech commands
  version     Get cxcli version

Flags:
  -c, --credentials string   verbose error output (with stack trace)
  -h, --help                 help for cxcli
  -o, --output string        Output Format (default text)
  -u, --skip-update-check    Skip the check for updates check run before every command
  -v, --verbose              verbose error output (with stack trace)

Profile NLU Test Suites

To run test suites, you can execute the following command

Usage:
  cxcli profile-nlu execute [suite-file] [flags]

Aliases:
  execute, execute, e, exe, exec

Flags:
  -h, --help   help for execute

Global Flags:
  -c, --credentials string   verbose error output (with stack trace)
  -o, --output string        Output Format (default "text")
  -u, --skip-update-check    Skip the check for updates check run before every command
  -v, --verbose              verbose error output (with stack trace)

Example: cxcli profile-nlu execute "examples/suite.yaml" --credentials credentials.json

You can find a suite example here

CICD for your Dialogflow CX environments

To execute a CICD pipeline you can execute the following command

Usage:
  cxcli cicd execute [environment] [flags]

Aliases:
  execute, execute, e, exe, exec

Flags:
  -a, --agent-name string    Dialogflow CX Agent Name
  -h, --help                 help for execute
  -l, --location-id string   Dialogflow CX Location ID of the Project
  -p, --project-id string    Dialogflow CX Project ID

Global Flags:
  -c, --credentials string   verbose error output (with stack trace)
  -o, --output string        Output Format (default text)
  -u, --skip-update-check    Skip the check for updates check run before every command
  -v, --verbose              verbose error output (with stack trace)

Example: cxcli cicd execute "<your-env>" --project-id <your-project-id> --location-id <your-location-id> --agent-name <your-agent-name> --credentials, credentials.json

Text-to-Speech

To transform your text to speech, you can execute the following command:

Usage:
  cxcli tts synthesize [input] [flags]

Aliases:
  synthesize, synth, s

Flags:
  -h, --help            help for synthesize
  -i, --input string    Input text to synthesize
  -l, --locale string   Input locale
  -o, --output string   Output file name (default "output.mp3")

Global Flags:
  -c, --credentials string   verbose error output (with stack trace)
  -u, --skip-update-check    Skip the check for updates check run before every command
  -v, --verbose              verbose error output (with stack trace)

Example: cxcli tts synthesize "hi" -l en-US -o output.mp3 --credentials credentials.json

Documentation

Overview

Copyright © 2022 Xavier Portilla Edo

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.