isabella232 / genesyscloud-cli

CLI tool to interact with Genesys Cloud APIs.

Genesys Cloud CLI

⚠ WARNING: This is a result of a hackathon project and while it is functional it is not officially supported by the Genesys Development Group.

The Genesys Cloud cli is a tool to interact with Genesys Cloud

Note that if you us oh-my-zsh, it aliases gc to a git command, this cli works using either gc or gcli if you are using that alias.

Running locally

$ virtualenv venv
$ . venv/bin/activate
$ pip install --editable .

Local setup

The cli authenticates using client credentials which you will have to create yourself

gc profile new is the easiest way to setup your credentials. This will create a credentials file at ~/.genesyscloud/credentials and can support multiple profiles for different organizations.

$ gc profile new
Profile Name [DEFAULT]: mycompanyname
Genesys Cloud Environment (mypurecloud.com, usw2.pure.cloud): mypurecloud.com
OAuth Client ID: dfbdc514-e830-4745-bffa-1cb7ee7f2736
OAuth Client Secret: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

Profiles

With multiple profiles configured, you can either specify one when connnecting:

$ gc --profile <profilename> <command>

Or switch a named profile to the default

$ gc profile setdefault <profilename>

Configuration Options

~/.genesyscloud/config contains configurable options in the DEFAULT section

[DEFAULT]
output_type = yaml

Command Structure

The Genesys Cloud cli uses a multipart structure

$ gc <command> <subcommand> [options and params]

Pagination

For resources that have multiple pages such as listing users, there are options available on how to process the pages. By default the cli uses a page size of 250 and retrieves all items.

--page-size    # set a page size other than 250
--page-number   # return a specific page

Data Inputs

Some commands require bodies to be sent with the request, such as creating a new user. The body can be supplied a number of ways.

1. Passing json with the command (escaped whitespace is not currently supported)

   $ gc users new "{\"name":\"Joe Smith\"}"
   

2. Referencing a file

   $ gc users new user.json
   

3. Stream input

   $ gc users new < user.json
   

   $ echo "{\"name":\"Joe Smith\"}" | gc user new