The Agent

The JSPOT Agent is a simple tool for interacting with JSPOT. It allows you to capture screenshots from URLs or screens and upload them.

1. Download the Agent (v0.9, 2025-03-18)

2. Run the Agent

You can run the agent via the command line using the following command format:

                jspot.exe --hash <monitor_hash> --url <target_url> [--full_page] [--screen <screen_number>] [--crop_top <pixels>] [--crop_bottom <pixels>] [--crop_left <pixels>] [--crop_right <pixels>] [--instructions <path_to_instructions_file>]
            

Parameters:

• --hash: The monitor hash you want to upload to (required).
• --url: The URL you want to capture (required or --screen should be used instead).
• --screen: The screen number to capture (required or --url should be used instead).
• --full_page (optional): Use this flag to capture the entire webpage. If omitted, only the viewport is captured.
• --attachment (optional): Attach a file (e.g., logs) with the screenshot. Use --attachment /path/to/log.txt.
• --crop_top (optional): The number of pixels to crop from the top of the captured screenshot.
• --crop_bottom (optional): The number of pixels to crop from the bottom of the captured screenshot.
• --crop_left (optional): The number of pixels to crop from the left of the captured screenshot.
• --crop_right (optional): The number of pixels to crop from the right of the captured screenshot.
• --extra (optional): Extra text string (max 120 characters). Can be used for additional information such as UUID, environment, or similar.
• --instructions (optional): Path to a file containing instructions for actions to be performed on the page, such as [WAIT], [HIDE], [CLICK], etc. Example of instructions format: [WAIT] 2, [HIDE] .element-class, [CLICK] #button-id.

Example Commands

To capture a screenshot of a webpage and upload it to JSPOT:

                jspot.exe --hash XXX --url https://sunet.se --full_page
            

To capture a screenshot of a specific screen:

                jspot.exe --hash XXX --screen 1
            

To capture a screenshot of a webpage and crop it from the top and bottom:

                jspot.exe --hash XXX --url https://sunet.se --crop_top 100 --crop_bottom 50
            

To capture a screenshot of a webpage and perform additional actions from an instructions file:

                jspot.exe --hash XXX --url https://sunet.se --instructions "C:\path\to\instructions.txt"
            

Note: You must specify either a URL or a screen, but not both.

Instructions File Example

Here’s an example of what the instructions file might look like:

                [WAIT] 2
                [WAIT_ELEMENT] #login-button
                [CLICK] #login-button
                [HIDE] .advertisement-banner
            

The instructions file allows you to control additional actions such as waiting, clicking, hiding elements, etc. You can specify multiple actions, and they will be executed in sequence after the screenshot is captured.