{"id":21638095,"url":"https://github.com/purecloudlabs/genesyscloud-cli","last_synced_at":"2026-03-18T02:32:45.127Z","repository":{"id":149016235,"uuid":"317917661","full_name":"purecloudlabs/genesyscloud-cli","owner":"purecloudlabs","description":"CLI tool to interact with Genesys Cloud APIs.","archived":false,"fork":false,"pushed_at":"2024-02-13T23:04:41.000Z","size":21,"stargazers_count":3,"open_issues_count":1,"forks_count":1,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-11T17:00:01.942Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/purecloudlabs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-12-02T16:10:53.000Z","updated_at":"2024-03-02T13:08:03.000Z","dependencies_parsed_at":null,"dependency_job_id":"785bcb11-2c66-49c1-8288-7c951e790d32","html_url":"https://github.com/purecloudlabs/genesyscloud-cli","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/purecloudlabs/genesyscloud-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/purecloudlabs%2Fgenesyscloud-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/purecloudlabs%2Fgenesyscloud-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/purecloudlabs%2Fgenesyscloud-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/purecloudlabs%2Fgenesyscloud-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/purecloudlabs","download_url":"https://codeload.github.com/purecloudlabs/genesyscloud-cli/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/purecloudlabs%2Fgenesyscloud-cli/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30642995,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-18T01:41:58.583Z","status":"online","status_checked_at":"2026-03-18T02:00:07.824Z","response_time":104,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-25T04:08:09.760Z","updated_at":"2026-03-18T02:32:45.098Z","avatar_url":"https://github.com/purecloudlabs.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Genesys Cloud CLI\n\n\u003e ⚠ **WARNING:** This is a result of a hackathon project and while it is functional it is not officially supported by the Genesys Development Group.\n\nThe Genesys Cloud cli is a tool to interact with [Genesys Cloud](https://developer.mypurecloud.com/)\n\nNote 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. \n\n## Running locally\n```\n$ virtualenv venv\n$ . venv/bin/activate\n$ pip install --editable .\n```\n\n## Local setup\n\nThe cli authenticates using client credentials which you will have to [create yourself](https://help.mypurecloud.com/articles/create-an-oauth-client/)\n\n```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.\n\n```\n$ gc profile new\nProfile Name [DEFAULT]: mycompanyname\nGenesys Cloud Environment (mypurecloud.com, usw2.pure.cloud): mypurecloud.com\nOAuth Client ID: dfbdc514-e830-4745-bffa-1cb7ee7f2736\nOAuth Client Secret: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\n```\n\n### Profiles\nWith multiple profiles configured, you can either specify one when connnecting:\n\n```$ gc --profile \u003cprofilename\u003e \u003ccommand\u003e ```\n\nOr switch a named profile to the default\n\n```$ gc profile setdefault \u003cprofilename\u003e ```\n\n### Configuration Options\n\n```~/.genesyscloud/config``` contains configurable options in the DEFAULT section\n\n```\n[DEFAULT]\noutput_type = yaml\n```\n\n## Command Structure\n\nThe Genesys Cloud cli uses a multipart structure \n\n```\n$ gc \u003ccommand\u003e \u003csubcommand\u003e [options and params]\n```\n\n### Pagination\n\nFor 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.\n\n ```\n --page-size    # set a page size other than 250\n --page-number   # return a specific page\n ```\n\n### Data Inputs\n\nSome commands require bodies to be sent with the request, such as creating a new user.  The body can be supplied a number of ways.\n\n1) Passing json with the command (escaped whitespace is not currently supported)\n    ```\n    $ gc users new \"{\\\"name\":\\\"Joe Smith\\\"}\"\n    ```\n\n2) Referencing a file\n    ```\n    $ gc users new user.json\n    ```\n\n3) Stream input\n    ```\n    $ gc users new \u003c user.json\n    ```\n\n    ```\n    $ echo \"{\\\"name\":\\\"Joe Smith\\\"}\" | gc user new\n    ```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpurecloudlabs%2Fgenesyscloud-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpurecloudlabs%2Fgenesyscloud-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpurecloudlabs%2Fgenesyscloud-cli/lists"}