AstronRPA Documentation

The AstronRPA Frontend is a monorepo containing several core packages for different application types and shared resources:

Core Packages

• @rpa/web-app: Main web application.
• @rpa/electron-app: Desktop application.
• @rpa/browser-plugin: Browser extension.
• @rpa/components: Shared UI components.
• @rpa/shared: Shared tools.
• @rpa/locales: Internationalization resources.

The Astron Browser Plugin is a core component of Astron RPA designed for web automation. It provides automation capabilities for browsers such as Chrome, Edge, and Firefox.

Key Features:

• Browser Tab operations
• Web element operations
• Cookie operations
• Script injection
• iframe operations

The optimize_input_prompt system transforms user-provided 'Operation Descriptions' or 'Interface Goals' into executable 'Optimized Instructions'.

Core Logic:

• Browser GUI Operations: Triggered if gui_targets are provided. The system uses specific placeholder syntax to reference existing elements or request missing ones.
• Data Processing Operations: Triggered if gui_targets are NOT provided. The system expands the user's description by adding required formats and examples without changing the original intent.

Key Terminology:

• Operation Description: The user's text requirement.
• Interface Goal: A collection of browser elements (including uuid, screenshots, and outerHTML).
• Optimized Instruction: The final, executable output generated by the system.

AstronRPA requires specific hardware and software environments to function correctly.

Operating System

• Windows: 10/11 (Primary support)

Hardware Configuration

Software Dependencies

The meta_json.py script follows this execution logic:

1. Component Execution: Iterates through the components directory (skipping astronverse-database) and runs each component's meta.py to generate/update local meta.json files.
2. Local Merging: Aggregates all component meta.json files into a temporary file temp_local.json.
3. Remote Fetching: Retrieves the current server-side meta configuration via the REMOTE_META_URL and saves it as temp_remote.json.
4. Synchronization: Merges local updates/additions into the remote configuration, producing temp_update.json. The logic prioritizes local changes while supplementing missing remote content.
5. Upload: Prompts the user to upload the final temp_update.json to the server via COMPONENTS_META_UPLOAD_URL.

For most users, the easiest way to install the AstronRPA client is to download the latest installation package from the official GitHub Releases page.

https://github.com/iflytek/astron-rpa/releases

To create a complete .msi installer after extensive changes, use the build.bat script in the project root.

# 1. Run in the project root directory
.\build.bat

# 2. Wait for build to complete (10-30 minutes)
# The new msi installer will be in build/dist/

# 3. Use the generated msi to reinstall

# 1. Run in the project root directory
.\build.bat

# 2. Wait for build to complete (may take 10-30 minutes)
# New msi installer will be generated in build/dist/ directory

# 3. Use the newly generated msi installer to reinstall
# - Run build/dist/*.msi file directly
# - Or replace it in the release directory for other users to download

For production deployment, use Docker Compose to manage the service containers.

1. Configure environment variables: Create a .env file with your production settings.
2. Start the services:

   docker-compose up -d

3. Monitor status:

   docker-compose ps
   docker-compose logs -f app

Unit Test Environment Deployment: To run tests in an isolated environment:

# Start test dependency services
docker-compose -f docker-compose.test.yaml up -d

# Run tests
pytest

AstronRPA requires Python 3.13.x as its core RPA engine. You can install it using several methods:

• Official Installer: Download from python.org.
• Winget: winget install Python.Python.3.13
• Chocolatey: choco install python --version=3.13.x

Note: You will need the installation path (e.g., C:\Users\{User}\AppData\Local\Programs\Python\Python313\python.exe) for later configuration.

To build the RPA browser plugin, ensure you are using Node.js v20+.

• Use npm run build to create a universal extension package compatible with Chrome and Edge browsers.
• Use npm run build:browser to package the plugin for a specific browser (Chromium or Firefox-based).

To support a specific browser variant with npm run build:browser, you must:

1. Set the custom_agent value in src/3rd/rpa_websocket.js.
2. Add the corresponding command to package.json where browser refers to the target browser's executable file name.