RoostGPT CLI Installation Guide - RHEL
Overview
RoostGPT is an AI-powered testing tool. This guide will help you install RoostGPT on your Ubuntu instance in just a few minutes.
Pilot Prerequisites
Before installing RoostGPT, ensure your system meets the following requirements:
| Requirement | Specification |
|---|---|
| Operating System | |
| Root Disk Space | Minimum 100 GB available |
| Network | Internet connection enabled |
| Permissions | sudo/root access required |
|
AWS Key & Secret
|
Set in environment or in .profile for accessing AWS Services |
|
RoostGPT License & Installer |
Provided by Roost Team |
|
AWS IAM User Role |
Policy: AmazonBedrockFullAccess or Custom Bedrock Policy as defined below |
|
AWS Bedrock Model |
global.anthropic.claude-sonnet-4-20250514-v1:0
|
Details are here: EC2 Requirements
RoostGPT can
AWS executedRole asand aPermissions numberfor ofIAM DockerUser
AWS Bedrock OR
Model Access
RoostGPT can be executed locally in which we require language and build tools dependency to be installed on ubuntu.EC2 (RHEL).List of Language, Build Tools and Dependencies:
Bundled artifact in the Roost installer
| Name | Purpose / Description | Location |
| roostgpt-linux | CLI executable for roostGPT | v1.1.18/roostgpt-linux |
| RoostJavaASTParser.jar | Java language AST Parser | v1.1.18/RoostJavaASTParser.jar |
| RoostPythonASTParser-linux | Python language AST Parser | v1.1.18/RoostGolangASTParser-linux |
| RoostGolangASTParser-linux | Golang language AST Parser | v1.1.18/RoostGolangASTParser-linux |
| RoostCSharpASTParser-linux | CSharp language AST Parser | v1.1.18/RoostCSharpASTParser-linux |
| RoostUITestGenerator-linux | UI Playwright Test Generator | v1.1.18/RoostUITestGenerator-linux |
| roostenc-linux | Decryt/Encrypt binary for troubleshooting RoostGPT behaviour | Not available publicly |
| license/license.ral | Roost License File | Not available publicly |
| workspace/postman-api-test | Sample swagger API spec file and env to generate postman collection with tests | API Spec: https://openweathermap.org/api |
| workspace/java-maven-test | Sample Java Maven project with env | roost-io/API-MusicBlender-Java |
| workspace/java-gradle-test | Sample Java Gradle project with env | roost-io/gradle-app |
| workspace/csharp-nunit-test | Sample CSharp DotNet project with env | roost-io/C-Sharp |
List of Language, Build Tools and Dependencies:
| Language | Dependency requirement |
| Java - Maven | JDK, JRE, Maven |
| Java - Gradle | JDK, JRE, Gradle |
| Csharp | dotnet |
| Golang | go |
| Python | python, pytest, unittest |
| Postman | No Dependency |
| Rest Assured | JDK, JRE, Maven |
| Karate | JDK, JRE, Maven |
Installation Steps
Step 1: ObtainCopy the installer and license file
- Download Installer
from Shared Google Drive
- You have
two optionstogetdownload the RoostGPTinstaller:installer
sharedOptionandA:RoostDownloadLicense file fromPublicaLocation#GoogleDownloadDrive.
Option B: Transfer via SCP
# From your local machine, copy installer and license to Ubuntu instance
scp roostgpt-installer.sh license.ral ubuntu@<your-instance-ip>:~/
# Then SSH into your instance
ssh ubuntu@<your-instance-ip>
# Move
Steplicense.ral 2:to Make$HOME/.roost
Installermkdir Executable
$HOME/.roost
mv $HOME/license.ral $HOME/.roost
# Add execute permissions to installer
chmod +x roostgpt-installer.sh
# Execute
Step 3: Run theRoost Installer
sudo ./roostgpt-installer.sh
You'll see a professional installation
Installation interface:
╔════════════════════════════════════════════════════════════╗
║ ║
║ RoostGPT Installer ║
║ ║
╚════════════════════════════════════════════════════════════╝
[→] Checking system requirements...
[✓] System requirements met
Continue with installation? [Y/n]
Press Y and Enter to continue.
The installer will:
- Extract files
- Install RoostGPT binary
Set upUnpack the code parsers- Copy workspace with pre-canned examples
- Configure all necessary permissions
Installation typically completes in under 1 minute.
Step 4: Verify Installation
After successful installation, you'll see:
╔════════════════════════════════════════════════════════════╗
║ ║
║ ✓ RoostGPT Installation Completed Successfully! ║
║ ║
╚════════════════════════════════════════════════════════════╝
Now you can run: roostgpt
Installed Roost License & AWS Configuration
Adding Roost License
Samples
# From your local machine, copy Roost license file to Ubuntu instance
scp license.ral ubuntu@<your-instance-ip>:~/license.ral
# Then SSH into your instance
ssh ubuntu@<your-instance-ip>
mkdir $HOME/.roost
mv $HOME/license.ral $HOME/.roost
Adding AWS Credentials
# SSH into your instance
ssh ubuntu@<your-instance-ip>
# Edit $HOME/.profile
vim $HOME/.profile
# Add export AWS keys
export AWS_ACCESS_KEY_ID=
export AWS_SECRET_ACCESS_KEY=
SourceShow the .profileinstalled
sample #workspaces
Either SSH into your instance again to automatically source the .profile
ssh ubuntu@<your-instance-ip>
# OR explicitly source the .profile
. $HOME/.profile
Using RoostGPT
Running RoostGPT
You can now run RoostGPT from anywhere on your system:
roostgpt help
Workspace Location
Your workspace with pre-canned examples is located at:
~/workspace
cdfind ~/workspace -ls
Structure - Roost Sample Workspace Structure
The workspace contains example projects to help you get started:
~/workspace/
├── Folder1/
│ └── .env # Configuration for project 1
└── Folder2/
└── .env # Configuration for project 2
Running
Configuring WorkspaceAWS ExamplesCredentials
Adding AWS Credentials
# NavigateSSH into your instance
ssh ubuntu@<your-instance-ip>
# Edit $HOME/.profile
vim $HOME/.profile
# Add export AWS keys to workspaceyour cd$HOME/.profile ~/workspaceand save the file
export AWS_ACCESS_KEY_ID=xxx
export AWS_SECRET_ACCESS_KEY=xxx
# OrSource specifythe afile specific.profile folderto cdmake ~the AWS creds available in the same session
. $HOME/.profile
Using RoostGPT
Running RoostGPT
You can now access /workspace/Folder1 # Runrun RoostGPT directlyfrom anywhere on your projectssystem, using the command roostgpt
Quick Start Example
# 1. SSH into your Ubuntu instance
ssh ubuntu@<your-instance-ip>
# 2. Navigate to workspace
cd ~/workspaceworkspace/functional-test
# 3. ExploreRun RoostGPT
./run.sh
# OR you can run using the pre-cannedfull examples
ls -la
# 4. Switch to a particular example (like java-maven-test)
cd java-maven-test
# 4. Run RoostGPTcommand
roostgpt test create -c java-maven-functional-test.env
Viewing Roost Test Results
roostgpt test result
Here's a complete workflow from login to running RoostGPT:
ConfigurationConfigure a new test
Each project folder in your workspace contains a <SOME-TEST-NAME>.env file for configuration:configuration. You can copy this env and modify the contents for a new test run. Execute roostgpt as
# EditCopy Folder1an existing configuration nanoto a new file
cp ~/workspace/Folder1/.env new_test.env
# Edit Folder2 configuration
nanovim ~/workspace/Folder2/.new_test.env
###################################
# Modify the below attributes
TEST_NAME=ANY_UNIQUE_NAME # Any unique_name to represent the test configuration
TEST_TYPE=functional # Default is unit; Supports [unit, functional, api-spec-test, integration]
AI_TYPE=bedrock_ai # Default is openai; Supports [openai, azure_open_ai, claude_ai, dbrx, bedrock_ai, gemini]
ROOST_USER_INPUT="" # The user input will be used to generate tests
ROOST_USER_INPUT_TYPE=file # Roost User input Type for test generation; Supports [text, file]
ROOST_USER_INPUT_FILE=USER_FILE_PATH # The user input file-path will be used to generate tests
# GIT env vars
GIT_TYPE=local # Default is github; Supports [github, gitlab, azure, bitbucket, local]
LOCAL_PROJECT_PATH=PATH_TO_WORKSPACE_FOLDER # Required if GIT_TYPE is local, Path to your workspace.
# AWS Bedrock env vars
AWS_ACCESS_KEY_ID= # Required: If not defined here, it will be picked from environment
AWS_SECRET_ACCESS_KEY= # Required: If not defined here, it will be picked from environment
AWS_SESSION_TOKEN= # Optional; AWS Session token.
AWS_DEFAULT_REGION=eu-west-1 # Required if AI_TYPE=aws_bedrock.
AWS_BEDROCK_MODEL_TYPE=cross-region # Required if AI_TYPE=aws_bedrock.
AWS_BEDROCK_MODEL=global.anthropic.claude-sonnet-4-20250514-v1:0 # Required if AI_TYPE=aws_bedrock.
# Api Spec env vars
API_SPEC_TYPE=swagger # Optional; Supports [swagger]
API_SPEC_SOURCE=file # Optional; Supports [file, gitpath, url]
API_SPEC_FILE_PATH="$HOME/FILE" # Optional; path of the source file.
API_SPEC_URL= # Optional; URL of the source file, if source is url
###################################
# Run the new test configuration
roostgpt test -c new_test.env
Troubleshooting
Installation Issues
Problem: Permission denied when running installer
# Solution: Make sure you're using sudo
sudo ./roostgpt-installer.sh
Problem: Command not found: roostgpt
# Solution: Verify installation completed successfully
which roostgpt
# Should output: /usr/local/bin/roostgpt
# Check executable permissions on roostgpt and grant if missing
chmod +x $(which roostgpt)
# If not found, re-run the installer
sudo ./roostgpt-installer.sh
Problem: Insufficient disk space
# Solution: Check available space
df -h / /var/tmp/Roost
# Free up space or use an instance with more storage
Runtime Issues
Problem: Can't find workspace
# Solution: Workspace is in your home directory
cd ~/workspace
ls -la
Problem: Configuration not loading
# Solution: Ensure .env files exist and are readable
find ~/workspace/ -name '*.env' -ls
find ~/workspace/ -name '*.env' -exec chmod 644 {} \;