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	Ubuntu 22.04 LTS
Root Disk Space	Minimum 100 GB available
Network	Internet connection enabled
Permissions	sudo/root access required
AWS Key & Secret             OR  AWS Bedrock token	Set in environment or in .profile for accessing AWS Services

Details are here: EC2 Requirements

RoostGPT can be executed as a number of Docker containers
                                   OR
RoostGPT can be executed locally in which we require language and build tools dependency to be installed on ubuntu.

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

 Bundled artifact in the 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

Installation Steps

Step 1: Obtain the Installer

You have two options to get the RoostGPT installer:

Option A: Download from Public Location

# Download the installer (replace URL with actual location)
wget https://your-public-location/roostgpt-installer.sh

# Or using curl
curl -O https://your-public-location/roostgpt-installer.sh

Option B: Transfer via SCP

# From your local machine, copy installer to Ubuntu instance
scp roostgpt-installer.sh ubuntu@<your-instance-ip>:~/

# Then SSH into your instance
ssh ubuntu@<your-instance-ip>

---

Step 2: Make Installer Executable

chmod +x roostgpt-installer.sh

---

Step 3: Run the Installer

sudo ./roostgpt-installer.sh

You'll see a professional 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 up 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

---

Roost License & AWS Configuration  

Adding Roost License

# 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=

Source the .profile 

# 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

Navigate to your workspace:

cd ~/workspace

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 RoostGPT on Workspace Examples

# Navigate to workspace
cd ~/workspace

# Or specify a specific folder
cd ~/workspace/Folder1

# Run RoostGPT directly on your projects
roostgpt test create -c <folder1.env>

---

Quick Start Example

# 1. SSH into your Ubuntu instance
ssh ubuntu@<your-instance-ip>

# 2. Navigate to workspace
cd ~/workspace

# 3. Explore the pre-canned examples
ls -la

# 4. Switch to a particular example (like java-maven-test)
cd java-maven-test

# 4. Run RoostGPT
roostgpt test create -c java-maven-test.env

Here's a complete workflow from login to running RoostGPT:

---

Configuration

Each project folder in your workspace contains a .env file for configuration:

# Edit Folder1 configuration
nano ~/workspace/Folder1/.env

# Edit Folder2 configuration
nano ~/workspace/Folder2/.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

# If not found, re-run the installer
sudo ./roostgpt-installer.sh

Problem: Insufficient disk space

# Solution: Check available space
df -h /
# 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 {} \;

---