Skip to main content

Roost on Windows

Steps to install

Use the Windows installer provided by Roost team. 

Upon a successful installation, you will see the files copied on your system

File Name Type Location

roostgpt-win.exe

 Windows executable C:\Program Files (x86)\RoostGPT [Default]

RoostJavaASTParser.jar

 Java archive $USER_PROFILE\var\tmp\Roost\bin

RoostUITestGenerator-win.exe

 Windows executable $USER_PROFILE\var\tmp\Roost\bin

license.ral

 Encrypted data file $USER_PROFILE/.roost

roost-workspace (folder)

 RoostGPT Pre-canned Samples $USERPROFILE/roost-workspace

Pre-requisites to run Roost Generated Tests

To run the Roost generated tests successfully on the local system, you will need pre-requisites installed on the system

Pre-requisites for Java Unit Test:

    • JDK/JRE

    • Maven/Gradle

Pre-requisites for API Spec Test:

    • Postman/Newman

Pre-requisites for UI Test:

    • Playwright

Configure AWS Credentials

# Add AWS keys to your $HOME/.profile and save the file OR
setx AWS_ACCESS_KEY_ID "xxx"
setx AWS_SECRET_ACCESS_KEY "xxx"
setx AWS_DEFAULT_REGION "eu-west-1"
setx AWS_BEDROCK_MODEL_TYPE "cross-region" # Supports [foundation, cross-region]
setx AWS_BEDROCK_MODEL "global.anthropic.claude-sonnet-4-20250514-v1:0"

Roost Samples

Structure - Roost Sample Workspace 

The workspace contains example projects to help you get started:

~/workspace/
├── functional-test/
    └── functional-test.env             # Configuration for POC 1
    └── prepaid-card-requirement.docx   # Sample user requirements doc for POC 1
    └── prepaid-card-swagger.yaml       # Required yaml for the POC 1
└── postman-api-test/
    └── postman-api-test.env          # Configuration for POC 2
    └── prepaid-card-swagger.yaml     # Sample Swagger Spec for POC 2
    └── weather.yaml                  # Sample Swagger Spec for POC 2

Using RoostGPT

Running RoostGPT

You can now access RoostGPT from anywhere on your system, using the command roostgpt

Quick Start Example

# 1. Navigate to workspace
cd ~/workspace/functional-test

# 2. Run RoostGPT
./run.sh

# OR you can run using the full command
roostgpt test create -c functional-test.env


Viewing Roost Test Results

# Roostgpt test results can be viewed using the below command
roostgpt test result

# A sample Postman Collection with tests from a swagger spec will be generated under a folder
postman_collections/
 |_  modified_postman_weather.json
 |_  postman-api-test/
       |_    Realtime_API.json
       |_    Forecast_API.json
       |_    Future_API.json
       |_    History_API.json
       |_    Marine_Weather_API.json
       |_    Search_Autocomplete_API.json
       |_    IP_Lookup_API.json
       |_    Time_Zone_API.json
       |_    Astronomy_API.json

Back to top