GitHub Connector CLI Setup Guide


Before getting started please make sure to have generated GitHub API keys, please refer the UI Guide for the same

Step 1 : Download an exising configuration

To get a template for the GitHub slice configuration save the output of the describe --input-parameters command as follows:

datacoral collect describe --slice-type github --input-parameters > github_parameters_file.json

Step 2 : Update the parameters file

  • The downloaded parameter file and update it with credentials, please refer to the UI Guide to generate the auth_token.

Example template for downloaded parameters file

  • auth_token- your auth_token from prerequisites

  • user_agent- username or application name

    Example templates:

"auth_token": "7cb8f17bcec0542680dcfgvhbjn4c8bea05957e3"
"user_agent": "test_username"

Step 3 : Add the connector

datacoral collect add --slice-type github --slice-name <slice-name> --parameters-file <params-file>
  • slice-name Name of your connector. A schema with your <connector-name> is automatically created in your warehouse
  • params-file File path to your input parameters file. Ex. github_parameters_file.json

Got questions? Interested?

Please contact Datacoral's Support Team, we'd be more than happy to answer any of your questions.