RoostGPT CLI

Instructions for creating .env file

you must create your .env file in the same location where your RoostGPT binary is located. Here is what the content of your .env file will look like:

GIT_TYPE="github"
GIT_TOKEN="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"ghp_************************************"
OWNER_NAME="rahulgoyal436"git_username"
REPO_NAME="spring-boot-examples"repo_name"
REPO_ID="632519132"repo_id"
PROJECT_NAME=""
PROJECT_ID=""
BASE_BRANCH="master"
RELATIVE_DIRECTORY="spring-boot-2-jdbc-with-h2"relative_directory_name"

# GPT env vars
OPENAI_API_MODEL="gpt-4"
OPENAI_API_KEY="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"******************************************"

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

# Jira board env vars
JIRA_EMAIL="rahul_goyal@zb.io"jira_email"
JIRA_HOST_NAME="zbio._____.atlassian.net"
JIRA_PASSWORD=""

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

# Logstash env vars
LOG_STASH_TYPE="api"
LOG_STASH_DATA=""
LOG_STASH_URL="https://52.66.106.18:9200**************"
LOG_STASH_USE_API_KEY="true"
LOG_STASH_API_KEY="SElxM2xZZ0JXR29BNWVHV24xekQ6NzFERWdBWjFTUmEzSFc2UFcwYzBtQQ==SElx*************************************************"
LOG_STASH_USER_NAME="elastic"
LOG_STASH_TOKEN="lC_tvrlVN4=nOdYSBexy"lC_*****************"

# Swagger env vars
USE_SWAGGER_URL="true"
SWAGGER_DATA="https://roost-bookstack.s3.us-west-2.amazonaws.com/openapi.yaml****************************"

# Additional vars
TEST_NAME="dummy-test"
ROOST_DIR="/var/tmp/Roost/RoostGPT"
LANGUAGE="JAVA"
AI_MODEL="vertex"
PACKAGES_TO_SCAN="com.in28minutes.springboot.jdbc.h2.example.student""
ITERATION="0"
TRIGGER_ID="1234567"
TIMEOUT="30"
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 like 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 (~~GitHub~~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 (empty in this case).
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~~example "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 (~~set to~~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~~example "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 Boards.
AZURE_PROJECT: The name of the Azure Devops project.

# Logstash env vars

LOG_STASH_TYPE: Specifies the type of Logstash integration (~~set to~~example "api").
LOG_STASH_DATA: Additional data for ~~Logstash (empty in this case).~~Logstash.
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.
LOG_STASH_USER_NAME: The username for authenticating with Logstash.
LOG_STASH_TOKEN: The token for authenticating with Logstash.

# Swagger env vars

USE_SWAGGER_URL: Indicates whether to use a Swagger URL (set to "true").
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.
LANGUAGE: The programming language used (set to "JAVA").
AI_MODEL: The AI model being used (set to "vertex").
PACKAGES_TO_SCAN: The packages to be scanned.
ITERATION: The iteration number.
TRIGGER_ID: The ID of the trigger.
TIMEOUT: The timeout duration.
GITOPS: Indicates whether GitOps is enabled (set to "true").
TEST_TYPE: The type of test (~~set to~~example "unit").
RETRIGGER: Indicates whether retriggering is enabled (set to "false").
BOARD_TYPE: The type of board being used (~~set to~~example "jira").