Skip to main content

RoostGPT CLI

Instructions for creating .env file

GIT_TYPE="github"
GIT_TOKEN="ghp_************************************"
OWNER_NAME="git_username"
REPO_NAME="repo_name"
REPO_ID="repo_id"
PROJECT_NAME=""
PROJECT_ID=""
USER_IP=""
BASE_BRANCH="master"
RELATIVE_DIRECTORY="relative_directory_name"

# GPT env vars
OPENAI_API_MODEL="gpt-4"
OPENAI_API_KEY="sk-******************************************"

# Vertex env vars
VERTEX_PROJECT_ID="vertex-project"
VERTEX_REGION="us-central1"
VERTEX_BEARER_TOKEN="ya29.**************************************************************************************"
VERTEX_MODEL="text-bison"
VERTEX_FINE_TUNE="false"

# Jira board env vars
JIRA_EMAIL="jira_email"
JIRA_HOST_NAME="_____.atlassian.net"
JIRA_PASSWORD=""

# Azure board env vars
AZURE_ORG="azure_org"
AZURE_TOKEN="zvp******************************************"
AZURE_PROJECT="azure+project_name"

# Logstash env vars
LOG_STASH_TYPE="api"
LOG_STASH_DATA_PATH=""
LOG_STASH_URL="https://**************"
LOG_STASH_USE_API_KEY="true"
LOG_STASH_API_KEY="SElx*************************************************"
LOG_STASH_USER_NAME="elastic"
LOG_STASH_TOKEN="lC_*****************"

# Swagger env vars
SWAGGER_DATA="https://****************************"

# Additional vars
TEST_NAME="dummy-test"
ROOST_DIR="/var/tmp/Roost/RoostGPT"
LANGUAGE="JAVA"
AI_MODEL="vertex"
PACKAGES_TO_SCAN=""
ITERATION="2"
TRIGGER_ID="1234567"
TIMEOUT="60"
GITOPS="true"
TEST_TYPE="unit"
RETRIGGER="false"
BOARD_TYPE="jira"
Here's a description of each variable:
  • GIT_TYPE: Specifies the type of Git repository, in this case, it's set to "github", you have other options likesupports gitlab, bitbucket cloud, bitbucket server, azure devops.
  • GIT_TOKEN: A token for authenticating the specific Git repository.
  • OWNER_NAME: The name of the repository owner (Git username).
  • REPO_NAME: The name of the repository.
  • REPO_ID: The ID of the repository.
  • PROJECT_NAME: The name of the project.
  • PROJECT_ID: The ID of the project .
  • USER_IP: User IP required for "bitbucket_server".
  • BASE_BRANCH: The base branch of the repository (set to "master").
  • RELATIVE_DIRECTORY: The relative directory path within the repository.
# GPT env vars
  • OPENAI_API_MODEL: Specifies the version of the OpenAI API model to use (set to "gpt-4").
  • OPENAI_API_KEY: The API key for accessing the OpenAI API.
# Vertex env vars
  • VERTEX_PROJECT_ID: The ID of the Vertex project.
  • VERTEX_REGION: The region where the Vertex project is located (example "us-central1").
  • VERTEX_BEARER_TOKEN: The bearer token for accessing the Vertex API.
  • VERTEX_MODEL: The name of the Vertex model to use (set to "text-bison").
  • VERTEX_FINE_TUNE: Indicates whether fine-tuning is enabled for the model (set to "false").
# Jira board env vars
  • JIRA_EMAIL: The email address associated with your Jira account.
  • JIRA_HOST_NAME: The hostname of your Jira instance.
  • JIRA_PASSWORD: The password for your Jira account.
# Azure board env vars
  • AZURE_ORG: The organization associated with your Azure Devops account.
  • AZURE_TOKEN: The access token for authenticating with Azure Devops.
  • AZURE_PROJECT: The name of the Azure Devops project.
# Logstash env vars
  • LOG_STASH_TYPE: Specifies the type of Logstash integration (set to "api").
  • LOG_STASH_DATA: It is required if LOG_STASH_TYPE="file".
  • LOG_STASH_URL: The URL for the Logstash endpoint.
  • LOG_STASH_USE_API_KEY: Indicates whether Logstash uses an API key for authentication (set to "true").
  • LOG_STASH_API_KEY: The API key for authenticating with Logstash. It is required if LOG_STASH_USE_API_KEY="true"
  • LOG_STASH_USER_NAME: The username for authenticating with Logstash.
  • LOG_STASH_TOKEN: The token for authenticating with Logstash.
# Swagger env vars
  • SWAGGER_DATA: The URL for the Swagger file.
    # Additional vars
  • TEST_NAME: The name of the test (set to "dummy-test").
  • ROOST_DIR: The directory path for Roost. Default value is "/var/tmp/Roost/RoostGPT".
  • LANGUAGE: The programming language used (set to "JAVA"), supports "java", "go" & "python".
  • AI_MODEL: The AI model being used (set to "vertex"), supports gpt and vertex.
  • PACKAGES_TO_SCAN: The packages to be scanned.
  • ITERATION: The iteration number (set to 2).
  • TRIGGER_ID: The ID of the trigger. Unique id to identify multiple triggers
  • TIMEOUT: The timeout duration. (set to 60 min)
  • GITOPS: Indicates whether GitOps is enabled (set to "true").
  • TEST_TYPE: The type of test (set to "unit"), supports "unit" and "functional"
  • RETRIGGER: Indicates whether retriggering is enabled (set to "false").
  • BOARD_TYPE: The type of board being used (example "jira"), supports "jira" and "azure".
Back to top