CLI

Installation Command

RoostGPT binary is available at https://github.com/roost-io/roost-support/releases

The RoostGPT binary allows for unmatched flexibility during test generation, by allowing you to trigger test generation both locally and through git through the use of one simple .env file.

Add the "roostgpt-<linux|macos|win.exe>" binary to your PATH environment variable

For Linux/MacOS,  you can execute the below command to install roostgpt

curl https://raw.githubusercontent.com/roost-io/roost-support/master/roostgpt.sh | bash -

CLI Commands

roostgpt   (for mac) &  ./roostGPT-win.exe (for windows)

This command is used to run the RoostGPT CLI on your operating system.

• -h, --help: Displays the help message that provides information about the available options and usage.

• roostgpt version update: Update roostgpt version.
• roostgpt config create:  Creates roostgpt configuration file. The configuration file contains environment variables used by RoostGPT application.
  
  • --output-dir, -o <path>:  Creates a configuration file in a specific directory. The configuration file contains environment variables used by the RoostGPT application. Default path is pwd.
    
  • --name <name>: Creates the configuration file with specific name. Default name is default.env.

• roostgpt config update: Updates the roostgpt configuration file.

  • --config, -c <path>: Specifies the location of the environment configuration file. The configuration file contains environment variables used by the RoostGPT application.

  • --name <name>:  loads pwd/$name.env. It is ignored if the --file is provided.

• roostgpt test create: Triggers the test generation.

  • --config,-c <path>: Path to the configuration file if provided, Default value is pwd/default.env.
  • --docker,-d: Generate tests in a docker environment, see supported features to see what tool/language versions are supported.
  • --verbose,-v: Enable verbose logging(Debug mode).
• roostgpt test improve: Improve the selected test based on user feedback.
  • --docker,-d: Improve tests in a docker environment, see supported features to see what tool/language versions are supported.
    
  • --verbose,-v: Enable verbose logging(Debug mode).
• roostgpt test retrigger: Re-trigger the chosen test from where it left off during its last execution.
  
  • --docker,-d: Re-trigger tests in a docker environment, see supported features to see what tool/language versions are supported.
    
  • --verbose,-v: Enable verbose logging(Debug mode).

Instructions for creating .env file

An easy way to download the .env file is to use https://app.roost.ai/gptCLIForm

The .env file should be in the same folder path as RoostGPT binary.
Here is what the content of your .env file will look like:

# GIT env vars
GIT_TYPE=                                        # Default is github; Supports [github, gitlab, azure, bitbucket, local]
HOSTED_TYPE=                                     # Default is cloud; Supports [cloud, hosted]
GIT_HOSTED_URL=                                  # Required if HOSTED_TYPE=hosted
USE_SSH=                                         # Optional; Default is false; Supports [true, false]; SSH based auth for Git
LOCAL_PROJECT_PATH=                              # Required if GIT_TYPE is local, Path to your workspace.
SOURCE_GIT_CLONE_URL=                            # Optional; the source repo clone URL
SOURCE_GIT_TOKEN=                                # Required
SOURCE_OWNER_NAME=                               # Required
SOURCE_REPO_NAME=                                # Required
SOURCE_REPO_ID=                                  # Required for GIT_TYPE=gitlab
SOURCE_PROJECT_NAME=                             # Required for GIT_TYPE=azure
SOURCE_PROJECT_ID=                               # Required for GIT_TYPE=bitbucket
SOURCE_BASE_BRANCH=                              # Required
SOURCE_RELATIVE_DIRECTORY=                       # Optional; the relative path of the repository
SAME_TARGET_DETAIL=                              # Optional; Default true, Supports [true, false]
DESTINATION_GIT_CLONE_URL=                       # Optional; the destination repo clone URL
DESTINATION_GIT_TOKEN=                           # Required if SAME_TARGET_DETAIL=false
DESTINATION_OWNER_NAME=                          # Required if SAME_TARGET_DETAIL=false
DESTINATION_REPO_NAME=                           # Required if SAME_TARGET_DETAIL=false
DESTINATION_REPO_ID=                             # Required if SAME_TARGET_DETAIL=false and GIT_TYPE=gitlab
DESTINATION_PROJECT_NAME=                        # Required for GIT_TYPE=azure
DESTINATION_PROJECT_ID=                          # Required if SAME_TARGET_DETAIL=false and GIT_TYPE=bitbucket
DESTINATION_BASE_BRANCH=                         # Required if SAME_TARGET_DETAIL=false

# Open AI env vars
OPENAI_API_MODEL=                                # Optional; Default is gpt-4
OPENAI_API_KEY=                                  # Required if AI_TYPE=openai

# Vertex AI env vars
VERTEX_FINE_TUNE=                                # Optional; Default is false, Supports [true, false]
VERTEX_PROJECT_ID=                               # Required if AI_TYPE=vertexai
VERTEX_REGION=                                   # Required if AI_TYPE=vertexai and VERTEX_FINE_TUNE=true
VERTEX_BEARER_TOKEN=                             # Required if AI_TYPE=vertexai
VERTEX_MODEL=                                    # Required if AI_TYPE=vertexai; Supports [text-bison, code-bison, codechat-bison, text-bison-32k, code-bison-32k, codechat-bison-32k, gemini-pro]

# Azure Open AI env vars
AZURE_OPENAI_ENDPOINT=                           # Required if AI_TYPE=azure_open_ai
AZURE_DEPLOYMENT_NAME=                           # Required if AI_TYPE=azure_open_ai
AZURE_OPENAI_KEY=                                # Required if AI_TYPE=azure_open_ai
AZURE_OPENAI_VERSION=                            # Optional Default is 2023-12-01-preview

# Open source env vars
OPEN_SOURCE_MODEL_ENDPOINT=                      # Required if AI_TYPE=open_source_ai
OPEN_SOURCE_MODEL=                               # Optional; Supports [meta-llama/Llama-2-13b-chat, HuggingFaceH4/starchat-beta]

# Sagemaker model env vars
SAGEMAKER_MODEL_ENDPOINT=                        # Required if AI_TYPE=sagemake_model

# Claude AI env vars 
CLAUDE_AI_MODEL=                                 # Required if AI_TYPE=claude_ai
CLAUDE_AI_API_KEY=                               # Required if AI_TYPE=claude_ai

# DBRX AI env vars 
DBRX_MODEL_ENDPOINT=                             # Required if AI_TYPE=dbrx
DBRX_AUTH_TOKEN=                                 # Required if AI_TYPE=dbrx                                   
DBRX_MODEL_NAME=                                 # Required if AI_TYPE=dbrx

# Advanced AI env vars
AI_TEMPERATURE=                                  # Optional; Default value is 0.6

# Jira board env vars
JIRA_HOST_NAME=                                  # Required if TEST_TYPE=functional and BOARD_TYPE=jira
JIRA_EMAIL=                                      # Required if TEST_TYPE=functional and BOARD_TYPE=jira
JIRA_TOKEN=                                      # Required if TEST_TYPE=functional and BOARD_TYPE=jira
JIRA_ID=                                         # Optional if TEST_TYPE=functional and BOARD_TYPE=jira

# Azure board env vars
AZURE_ORG=                                       # Required if TEST_TYPE=functional and BOARD_TYPE=azure
AZURE_PROJECT=                                   # Required if TEST_TYPE=functional and BOARD_TYPE=azure
AZURE_TOKEN=                                     # Required if TEST_TYPE=functional and BOARD_TYPE=azure
AZURE_WORK_ITEM_ID=                              # Optional if TEST_TYPE=functional and BOARD_TYPE=azure

# Log env vars
LOG_SOURCE=                                      # Optional; Default is elks
LOG_SOURCE_PATH=                                 # Optional; the log file path
LOG_ELASTICSEARCH_URL=                           # Optional; the Elastic search URL
LOG_ELASTICSEARCH_USER=                          # Optional; the Elastic search user name
LOG_ELASTICSEARCH_TOKEN=                         # Optional; the Elastic search token
LOG_ELASTICSEARCH_API_KEY=                       # Optional; the Elastic search api key

# Behavioural test cases env vars
BEHAVIORAL_TEST_TYPE=                            # Optional; Supports [gherkin]
BEHAVIORAL_TEST_SOURCE=                          # Optional; Supports [file, gitpath, url]
BEHAVIORAL_TEST_FILE_PATH=                       # Optional; path of the source file if source is file/gitpath. Relative path in case of gitpath.
BEHAVIORAL_TEST_URL=                             # Optional; URL of the source file if source is url

# API Spec env vars
API_SPEC_TYPE=                                   # Optional; Supports [swagger, postman, raml]
API_SPEC_SOURCE=                                 # Optional; Supports [file, gitpath, url]
API_SPEC_FILE_PATH=                              # Optional; path of the source file if source is file/gitpath. Relative path in case of gitpath.
API_SPEC_URL=                                    # Optional; URL of the source file if source is url

HTTP_VERBS_FOR_TESTING=                          # Optional; Default is "get,post,put,patch,delete", Supports all the combinations of http verbs. The specific http methods to be tested for all APIs. Enter "," seperated values here. 
REGEX_HTTP_ENDPOINTS_FOR_TESTING=                # Optional; Regex string that matches to specific endpoints that needs to be tested. If empty, all the endpoints will be tested.

# Application test env vars
APPLICATION_ENTRYPOINT=                          # Required; if you need to generate application tests along with unit tests. This feature is supported only for GPT Turbo models. Use a relative path from the project root.

# License env vars
ROOST_DOMAIN=                                    # Optional; Default is app.roost.ai
ROOST_TOKEN=                                     # Optional; the Roost token or license filepath, default $HOME/.roost/license.ral
TELEMETRY=                                       # Optional; Default is true, Supports [true, false], send telemetry data to roost, no private information is shared.

# Additional env vars
TEST_NAME=                                       # Optional; Default is roost-test
ROOST_DIR=                                       # Optional; Default is /var/tmp/Roost/RoostGPT
LANGUAGE=                                        # Optional; Default is java; Supports [java, go, python, csharp, nodejs, reactjs, cpp]
AI_TYPE=                                         # Optional; Default is openai; Supports [openai, vertexai, azure_open_ai, open_source_ai, sagemaker_model, claude_ai, dbrx]
JAVA_BUILD_TOOL=                                 # Optional; Default is maven; Supports [maven, gradle]
PACKAGES_TO_SCAN=                                # Optional; Default is "*"; used for LANGUAGE=java, for generating tests for specific packages; Enter comma seperated values. E.g. "com.demo.sample,"com.example.products"
ITERATION=                                       # Optional; Set VERIFY_TEST=true to enable iteration; Default value of ITERATION is 1
TIMEOUT=                                         # Optional; Default is 1 hour
CREATE_API_SPEC=                                 # Optional; Used for TEST_TYPE=functional
ROOST_USER_INPUT=                                # Optional; The user input will be used to generate tests.
TEST_TYPE=                                       # Optional; Default is unit Supports [unit, functional, artillery, integration, api-spec-test]
RETRIGGER=                                       # Optional; Default is false, Supports [true, false]
TRIGGER_ID=                                      # Unique id to identify multiple triggers; Default is epoch
BOARD_TYPE=                                      # Optional; Default is jira; Supports [jira, azure, none]
MAX_DEPTH=                                       # Optional; Default is -1; if MAX_DEPTH is -1, it will traverse all the sub directories else the maximum depth directories to look for
TEST_FRAMEWORK=                                  # Optional; Default is "pytest" for Python, "gotest" for Golang, "JUnit4" for Java, "nunit" for CSharp, "jest" for Node.js, "postman" for Postman test-script. Supports [pytest, unittest] for Python, [gotest] for Golang, [JUnit4, JUnit5] for Java, [nunit] for Csharp, [jest] for Node.js, [postman, artillery, rest-assured] for [test_type: api-spec-test]
FUNCTIONS_TO_TEST=                               # Optional; List of function names to be tested, separated by comma. Name to be specified as module.[class.]method OR module.function
USE_ASSISTANT=                                   # Optional; Use Assistant feature in openai. Default:false
USE_CACHE=                                       # Optional; Used for only developer. Default:false
VERIFY_TEST=                                     # Optional; Default is true, Supports [true, false]
VULNERABILITY_GEN=                               # Optional; Default is false, Supports [true, false]
CUSTOM_TAGS=                                     # Optional; The tags to be attached to test code, so that the test's can run based on tags
CONSIDER_EXISTING_TEST=                          # Optional; Default is false, Supports [true, false], used for Java and python unit test generation, It scans your repository to identify any existing tests for the specified function. If tests are found, it incorporates them into its consideration and generates additional test cases as needed

# Improve test env vars
GIT_PR_URL=                                      # The Git PR URL  of the generated test
IMPROVE_TEST=                                    # Optional; Default is false, Supports [true, false]
FILE_PATH=                                       # Required if IMPROVE_TEST=true
USER_CONTENT=                                    # Required if IMPROVE_TEST=true
TESTSCRIPT_ENDPOINT=                             # Required if IMPROVE_TEST=true and TEST_FRAMEWORK=postman

# Language version env vars, Used when RoostGPT is run in docker mode, visit https://docs.roost.ai/books/topics/roostgpt/page/cli to check the supported language versions
JAVA_VERSION=                                    # Optional; Default is 17, Used for TEST_FRAMEWORK "JUnit4, "JUnit5", "karate", "rest-assured"
MAVEN_VERSION=                                   # Optional; Default is 3.8.6, Used for TEST_FRAMEWORK "JUnit4, "JUnit5", "karate", "rest-assured"
GRADLE_VERSION=                                  # Optional; Default is 8.6, Used for TEST_FRAMEWORK "JUnit4, "JUnit5", "karate", "rest-assured"
GO_VERSION=                                      # Optional; Default is 1.19.9, Used for TEST_FRAMEWORK "gotest"
PYTHON_VERSION=                                  # Optional; Default is 3, Used for TEST_FRAMEWORK "pytest", "unittest"
DOTNET_VERSION=                                  # Optional; Default is 8, Used for TEST_FRAMEWORK "nunit"
NODE_VERSION=                                    # Optional; Default is 18.18.0, Used for TEST_FRAMEWORK "artillery", "postman", "rest-assured", "karate", "jest", "mocha"

Here's a description of each variable:

# Git env vars

• GIT_TYPE:
  Description: Specifies the type of Git repository. 
  Default value isValue: "github"
   Supported values:Values: "github", "gitlab", "azure", "bitbucket"., (Optional)local
  Optional/Required: Optional
  
  
• HOSTED_TYPE:
  Description: WhereIndicates where the gitGit platform is accessible. 
  Default isValue: "cloud"
  Supported Values: "cloud", supports "cloud" and "hosted".
  Optional/Required: (Optional)Optional
  
• GIT_HOSTED_URL:
  Description: The URL of the hosted gitGit platform.
  Optional/Required: (Required if HOSTED_TYPE=HOSTED_TYPE is "hosted")
  
  
• USE_SSH:
  Description: SSHSpecifies whether to use SSH-based authauthentication for Git. 
  Default isValue: "false".
  Supported SupportsValues: "true", "false".
  Optional/Required: (Optional) Optional
  
  
• LOCAL_PROJECT_PATH:
  Description: Path to your workspaceworkspace.
  Optional/Required: (Required if GIT_TYPE is "local") 
  
  
• SOURCE_GIT_CLONE_URL
Description: Clone URL for the source repository.
Optional/Required: Optional


• SOURCE_GIT_TOKEN:
  Description: A tokenToken for authenticating the specific source Git repository.
  Optional/Required: (Required)Required
  
  
• SOURCE_GIT_CLONE_URL:SOURCE_OWNER_NAME
  Description: the source repo clone URL (Optional)
• SOURCE_OWNER_NAME: The nameName of the source repository owner (Git username).
  Optional/Required: (Required)Required
  
  
• SOURCE_REPO_NAME:
  Description: The nameName of the source repository.
  Optional/Required: (Required)Required
  
  
• SOURCE_REPO_ID: The
  Description: ID of the source repository.
  Optional/Required: (Required forif GIT_TYPE=GIT_TYPE is "gitlab")
  
  
• SOURCE_PROJECT_NAME:
  Description: The nameName of the source project.
  Optional/Required: (Required forif GIT_TYPE=GIT_TYPE is "azure")
  
  
• SOURCE_PROJECT_ID: The
  Description: ID of the source projectproject.
  Optional/Required: . (Required forif GIT_TYPE=GIT_TYPE is "bitbucket")
  
  
• SOURCE_BASE_BRANCH:
  Description: The baseBase branch that is to be tested in the source repository.
  Optional/Required: (Required)Required
  
  
• SOURCE_RELATIVE_DIRECTORY:
  Description: The relativeRelative directory path within the source repository.
  Optional/Required: Optional
  
  
• SAME_TARGET_DETAIL:
  Description: Set to trueIndicates if the destination gitGit details are the same as the source gitGit details. 
  Default valueValue: is"true"
  Supported Values: "true", Supports "true" and "false".
  Optional/Required: (Optional)Optional
  
  
• DESTINATION_GIT_CLONE_URL
Description: Clone URL for the destination repository.
Optional/Required: Optional


• DESTINATION_GIT_TOKEN:
  Description: A tokenToken for authenticating the specific destination Git repository.
  Optional/Required: (Required if SAME_TARGET_DETAIL=false)SAME_TARGET_DETAIL is "false"
  
  
• DESTINATION_GIT_CLONE_URL:DESTINATION_OWNER_NAME
  Description: the destination repo clone URL (Optional)
• DESTINATION_OWNER_NAME: The nameName of the destination repository owner (Git username).
  Optional/Required: (Required if SAME_TARGET_DETAIL=false)SAME_TARGET_DETAIL is "false"
  
  
• DESTINATION_REPO_NAME:
  Description: The nameName of the destination repository.
  Optional/Required: (Required if SAME_TARGET_DETAIL=false)SAME_TARGET_DETAIL is "false"
  
  
• DESTINATION_REPO_ID: The
  Description: ID of the destination repository.
  Optional/Required: (Required if SAME_TARGET_DETAIL=falseSAME_TARGET_DETAIL is "false" and GIT_TYPE=GIT_TYPE is "gitlab")
  
  
• DESTINATION_PROJECT_NAME:
  Description: The nameName of the destination project.
  Optional/Required: (Required if SAME_TARGET_DETAIL=falseSAME_TARGET_DETAIL is "false" and GIT_TYPE=GIT_TYPE is "azure")
  
  
• DESTINATION_PROJECT_ID: The
  Description: ID of the destination projectproject.
  Optional/Required: . (Required if SAME_TARGET_DETAIL=falseSAME_TARGET_DETAIL is "false" and GIT_TYPE=GIT_TYPE is "bitbucket")
  
  
• DESTINATION_BASE_BRANCH:
  Description: The baseBase branch in which the test code is to be pushed in the destination repository.
  Optional/Required: (Required if SAME_TARGET_DETAIL=false)SAME_TARGET_DETAIL is "false"

# Open AI env vars

# AZURE Open AI env vars

• AZURE_OPENAI_ENDPOINT:

  Description: The API Endpointendpoint used to access Azure OpenOpenAI AI.services.

  (

  Optional/Required: Required if AI_TYPE=AI_TYPE is "azure_open_ai")
  
• AZURE_DEPLOYMENT_NAME: Name

  Description: The name of the Azure Open AIOpenAI deployment (you wish to use.

  Optional/Required: Required if AI_TYPE=AI_TYPE is "azure_open_ai")
  
  
• AZURE_OPENAI_KEY:

  Description: The API key required for accessingauthenticating requests to Azure OpenAI.

  Optional/Required: Required if AI_TYPE is "azure_open_ai"
• AZURE_OPENAI_VERSION

  Description: Specifies the version of the Azure Open AIOpenAI API (Required if AI_TYPE="azure_open_ai")
• AZURE_OPENAI_VERSION: The version of Azure Open AI to be used.