### Install and Run AstronRPA Frontend

Source: https://github.com/iflytek/astron-rpa/blob/main/frontend/README.md

Commands to clone the repository, install dependencies, set environment variables, and start the development server for web and desktop applications.

```bash
pnpm install

pnpm set-env

pnpm dev:web

pnpm dev:desktop
```

--------------------------------

### Start Astron RPA Server with Docker Compose

Source: https://github.com/iflytek/astron-rpa/blob/main/BUILD_GUIDE.md

Navigate to the docker directory, copy the example environment file, modify it with your server IP, and then start all server services in detached mode.

```bash
# Enter Docker directory
cd docker

# Copy .env file
cp .env.example .env

# Modify casdoor service configuration in .env
CASDOOR_EXTERNAL_ENDPOINT="http://{YOUR_SERVER_IP}:8000"

# 🚀 Start all services
docker compose up -d

# 📊 Check service status
docker compose ps
```

--------------------------------

### Development Setup for CLI Package

Source: https://github.com/iflytek/astron-rpa/blob/main/frontend/packages/cli/README.md

Commands for setting up and developing the CLI package itself, including installing dependencies, building, type checking, and running in watch mode.

```bash
pnpm install
```

```bash
pnpm build
```

```bash
pnpm typecheck
```

```bash
pnpm dev
```

--------------------------------

### Installation

Source: https://github.com/iflytek/astron-rpa/blob/main/frontend/packages/cli/README.md

Instructions for installing the @rpa/cli package globally or locally.

```APIDOC
## Installation

You can install this package globally or locally in your project.

```bash
# Global installation
npm install -g @rpa/cli
# or
pnpm add -g @rpa/cli

# Local installation
npm install @rpa/cli --save-dev
# or
pnpm add @rpa/cli -D
```
```

--------------------------------

### Start Development Server

Source: https://github.com/iflytek/astron-rpa/blob/main/frontend/packages/cli/README.md

Use the `rpa dev` command to start the development server.

```bash
rpa dev
```

--------------------------------

### Start Development Server

Source: https://github.com/iflytek/astron-rpa/blob/main/backend/ai-service/README.zh.md

Command to start the FastAPI development server using uv.

```bash
uv run python run.py dev
```

--------------------------------

### Start Development Server

Source: https://github.com/iflytek/astron-rpa/blob/main/frontend/packages/electron-app/README.md

Use this command to start the development server for the Electron application.

```bash
pnpm dev
```

--------------------------------

### Environment Variables Configuration

Source: https://github.com/iflytek/astron-rpa/blob/main/backend/resource-service/README.md

Example of an `.env` file for configuring database connection details. Ensure these variables match your local or deployed database setup.

```bash
# Database configuration
DATABASE_HOST=localhost
DATABASE_PORT=3306
DATABASE_NAME=resource_service
DATABASE_USERNAME=your_db_username
DATABASE_PASSWORD=your_db_password
```

--------------------------------

### Start Services

Source: https://github.com/iflytek/astron-rpa/blob/main/docker/QUICK_START.md

Launches all defined services in the background.

```bash
docker compose up -d
```

--------------------------------

### Install project dependencies

Source: https://github.com/iflytek/astron-rpa/blob/main/engine/README.md

Install the required Python packages for the meta configuration script.

```bash
pip install requests python-dotenv
```

--------------------------------

### Initialize Environment Configuration

Source: https://github.com/iflytek/astron-rpa/blob/main/docker/QUICK_START.md

Copies the example environment file to create the local configuration.

```bash
cp .env.example .env
```

--------------------------------

### Manual Frontend Build Steps

Source: https://github.com/iflytek/astron-rpa/blob/main/BUILD_GUIDE.md

Commands to manually install dependencies and build the desktop application.

```bash
cd frontend

# 📦 Install dependencies
pnpm install

# ⚙️ Configure environment variables
pnpm set-env

# 🖥️ Build desktop application
pnpm build:desktop
```

--------------------------------

### Start Service with Spring Profiles

Source: https://github.com/iflytek/astron-rpa/blob/main/backend/resource-service/README.md

Execute the packaged JAR file to start the service, activating the 'local' Spring profile.

```bash
java -jar target/resource-0.0.1-SNAPSHOT.jar --spring.profiles.active=local
```

--------------------------------

### Install Dependencies

Source: https://github.com/iflytek/astron-rpa/blob/main/frontend/packages/electron-app/README.md

Run this command to install project dependencies using pnpm.

```bash
pnpm install
```

--------------------------------

### Start the Service

Source: https://github.com/iflytek/astron-rpa/blob/main/backend/openapi-service/README.md

Commands to launch the application in development mode.

```bash
# Use uvicorn directly (development environment)
uvicorn app.main:app --reload --host 0.0.0.0 --port 8020

# Or use uv
uv run python run.py dev
```

--------------------------------

### Build Client MSI Installer

Source: https://github.com/iflytek/astron-rpa/blob/main/FAQ.md

Execute the build script to create a new MSI installer for the client. This is recommended when updating multiple packages or for a complete client version update.

```bash
.\build.bat
```

--------------------------------

### Verify UV Installation

Source: https://github.com/iflytek/astron-rpa/blob/main/BUILD_GUIDE.md

Check the installed version of UV.

```bash
uv --version
# ✓ Should display something like: uv 0.8.x (xxxxx)
```

--------------------------------

### Configure Environment Variables

Source: https://github.com/iflytek/astron-rpa/blob/main/backend/openapi-service/README.md

Example configuration for database and Redis connections in the .env file.

```bash
# Database configuration
DATABASE_URL=mysql+aiomysql://username:password@localhost:3306/rpa_openapi

# Redis configuration
REDIS_URL=redis://localhost:6379/0

# Application name
APP_NAME="RPA OpenAPI Service"
```

--------------------------------

### Verify Docker Installation

Source: https://github.com/iflytek/astron-rpa/blob/main/BUILD_GUIDE.md

Confirm that Docker and Docker Compose are correctly installed.

```bash
docker --version
docker compose --version
# ✓ Confirm both Docker and Docker Compose are installed correctly
```

--------------------------------

### Install Project Dependencies

Source: https://github.com/iflytek/astron-rpa/blob/main/backend/ai-service/README.zh.md

Commands for installing project dependencies using pip or uv. uv is recommended for consistent version locking.

```bash
# 使用 pip 安装
pip install -e .

# 或使用 uv (推荐)
uv sync
```

--------------------------------

### Install UV Package Manager

Source: https://github.com/iflytek/astron-rpa/blob/main/BUILD_GUIDE.md

Installation commands for the UV Python package manager.

```powershell
# Method 1: Official installation script (Recommended)
powershell -c "irm https://astral.sh/uv/install.ps1 | iex"

# Method 2: Using pip
pip install uv

# Method 3: Using Chocolatey
choco install uv
```

--------------------------------

### Install Python 3.13.x

Source: https://github.com/iflytek/astron-rpa/blob/main/BUILD_GUIDE.md

Methods for installing the required Python version on Windows.

```bash
# Visit https://www.python.org/downloads/
# Download and install Python 3.13.x
```

```bash
winget install Python.Python.3.13
```

```bash
choco install python --version=3.13.x
```

--------------------------------

### Build and Start Local Server

Source: https://github.com/iflytek/astron-rpa/blob/main/FAQ.md

Use this command to build the Docker image and start the server in detached mode. Ensure you have commented out the 'image' line and uncommented the 'build' section in your docker-compose.yml.

```bash
docker-compose up -d --build
```

--------------------------------

### Install @rpa/cli Globally

Source: https://github.com/iflytek/astron-rpa/blob/main/frontend/packages/cli/README.md

Install the CLI tool globally for system-wide access using npm or pnpm.

```bash
npm install -g @rpa/cli
```

```bash
pnpm add -g @rpa/cli
```

--------------------------------

### Install @rpa/cli Locally

Source: https://github.com/iflytek/astron-rpa/blob/main/frontend/packages/cli/README.md

Install the CLI tool as a development dependency in your project using npm or pnpm.

```bash
npm install @rpa/cli --save-dev
```

```bash
pnpm add @rpa/cli -D
```

--------------------------------

### Verify pnpm Installation

Source: https://github.com/iflytek/astron-rpa/blob/main/BUILD_GUIDE.md

Check the installed version of pnpm.

```bash
pnpm --version
# ✓ Should display 9.x.x or higher
```

--------------------------------

### Verify SWIG Installation

Source: https://github.com/iflytek/astron-rpa/blob/main/BUILD_GUIDE.md

Run this command to confirm that SWIG has been installed correctly and is accessible in your system's PATH.

```bash
swig -version
```

--------------------------------

### Troubleshoot Python Environment

Source: https://github.com/iflytek/astron-rpa/blob/main/BUILD_GUIDE.md

Verify Python installation paths and correct usage for the build script.

```bash
# 🔍 Check Python installation path
where python  # Windows
which python  # Linux/macOS

# 🔍 Make sure to pass the Python executable file

✖️ ./build.bat -p "C:\\Python313"
✔️ ./build.bat -p "C:\\Python313\\python.exe"
```

--------------------------------

### Install pnpm Package Manager

Source: https://github.com/iflytek/astron-rpa/blob/main/BUILD_GUIDE.md

Installation commands for the pnpm Node.js package manager across different platforms.

```bash
# Method 1: Using npm (Recommended)
npm install -g pnpm@latest

# Method 2: Windows PowerShell
iwr https://get.pnpm.io/install.ps1 -useb | iex

# Method 3: macOS/Linux
curl -fsSL https://get.pnpm.io/install.sh | sh -

# Method 4: Homebrew (macOS)
brew install pnpm
```

--------------------------------

### Configure Environment Variables

Source: https://github.com/iflytek/astron-rpa/blob/main/backend/ai-service/README.zh.md

Example `.env` file content showing necessary configurations for database, Redis, and various AI services like DeepSeek, Xfyun OCR, and JFBym captcha.

```dotenv
# 数据库配置
DATABASE_URL=mysql+aiomysql://username:password@localhost:3306/ai_service
DATABASE_USERNAME=your_db_username
DATABASE_PASSWORD=your_db_password

# Redis 配置
REDIS_URL=redis://localhost:6379/0

# AI 聊天服务配置
AICHAT_BASE_URL=https://api.deepseek.com/v1/
AICHAT_API_KEY=your_deepseek_api_key

# 讯飞 OCR 配置
XFYUN_APP_ID=your_xfyun_app_id
XFYUN_API_SECRET=your_xfyun_api_secret
XFYUN_API_KEY=your_xfyun_api_key

# 云码验证码配置
JFBYM_API_TOKEN=your_jfbym_token

# 积分策略配置，这个也可以不配置，使用默认的 .env.default
MONTHLY_GRANT_AMOUNT=100000
AICHAT_POINTS_COST=100
OCR_GENERAL_POINTS_COST=50
JFBYM_POINTS_COST=10
```

--------------------------------

### Example Log Entry

Source: https://github.com/iflytek/astron-rpa/blob/main/backend/resource-service/README.md

This is an example of an INFO level log entry showing a successful file upload and its corresponding file ID.

```log
2024-01-01 10:30:15.123 INFO  [http-nio-8030-exec-1] c.i.r.r.f.s.i.FileServiceImpl : File upload successful, file ID: file-uuid-12345
```

--------------------------------

### Build Astron RPA Client for Windows (Basic)

Source: https://github.com/iflytek/astron-rpa/blob/main/BUILD_GUIDE.md

Execute the build script from the project root to package the RPA engine and frontend. Ensure Python 3.13.x is installed and accessible.

```bash
# 🚀 Full build (engine + frontend)
./build.bat --python-exe "C:\Program Files\Python313\python.exe"

# Or use default configuration (if Python is in default path)
./build.bat

# ⏳ Wait for operation to complete
# ✅ Build successful when console displays "Full Build Complete!"
```

--------------------------------

### Log Monitoring

Source: https://github.com/iflytek/astron-rpa/blob/main/backend/ai-service/README.md

Commands and examples for viewing application logs.

```bash
# Real-time view of application logs
tail -f logs/app.log
```

```text
2025-06-03 10:30:15 - app.main - [abc-123-def] - INFO - Root endpoint accessed!
```

--------------------------------

### Log Record Example

Source: https://github.com/iflytek/astron-rpa/blob/main/backend/openapi-service/README.md

An example of a structured log record, including timestamp, module, request ID, log level, and message.

```text
2025-06-06 10:30:15 - app.main - [abc-123-def] - INFO - Root endpoint accessed!
```

--------------------------------

### Prepare Python Environment for Build

Source: https://github.com/iflytek/astron-rpa/blob/main/README.md

Prepare a Python 3.13.x installation directory. This directory will be copied to create the python_core for the RPA engine.

```bash
# Prepare a Python 3.13.x installation directory (can be a local folder or system installation path)
# The script will copy this directory to create python_core
```

--------------------------------

### API Authentication Header Example

Source: https://github.com/iflytek/astron-rpa/blob/main/backend/ai-service/README.zh.md

Example of how to include the user ID in the request header for API authentication.

```http
X-User-Id: 123
# 或
user_id: 123
```

--------------------------------

### Build Frontend Manually

Source: https://github.com/iflytek/astron-rpa/blob/main/BUILD_GUIDE.zh.md

Steps to manually build the frontend part of the RPA client, including dependency installation and desktop application build.

```bash
cd frontend
pnpm install
pnpm set-env
pnpm build:desktop
```

--------------------------------

### Deploy Test Environment with Docker Compose

Source: https://github.com/iflytek/astron-rpa/blob/main/backend/ai-service/README.md

Start the necessary services for the unit test environment using a specific Docker Compose file.

```bash
docker-compose -f docker-compose.test.yaml up -d
```

--------------------------------

### Create New Plugin

Source: https://github.com/iflytek/astron-rpa/blob/main/frontend/packages/cli/README.md

Use the `rpa create` command to scaffold a new plugin template. Options for name and target directory can be provided, or interactive prompts will guide you.

```bash
rpa create
```

```bash
rpa create --name my-plugin --target ./packages/my-plugin
```

--------------------------------

### Check Docker and Compose Versions

Source: https://github.com/iflytek/astron-rpa/blob/main/BUILD_GUIDE.zh.md

Verifies that Docker and Docker Compose are installed and accessible, which is crucial for troubleshooting startup issues.

```bash
# ✅ 检查 Docker 状态
docker --version
docker compose --version
```

--------------------------------

### Chat Completion API cURL Example

Source: https://context7.com/iflytek/astron-rpa/llms.txt

Example of how to call the Chat Completion API using cURL. Includes setting the Content-Type and a custom User-Id header.

```bash
# curl example:
curl -X POST "http://localhost:8000/api/v1/chat/completions" \
  -H "Content-Type: application/json" \
  -H "X-User-Id: user123" \
  -d '{
    "model": "maas/deepseek-v3.2",
    "stream": false,
    "messages": [{"role": "user", "content": "Hello"}]
  }'
```

--------------------------------

### Run Uvicorn with Custom Port

Source: https://github.com/iflytek/astron-rpa/blob/main/backend/openapi-service/README.md

Start the uvicorn server on a specific host and port, overriding the default configuration.

```bash
uvicorn app.main:app --host 0.0.0.0 --port 8020
```

--------------------------------

### Deploy AstronRPA Server with Docker

Source: https://github.com/iflytek/astron-rpa/blob/main/README.md

Use this bash script to clone the repository, navigate to the docker directory, copy the environment file, modify Casdoor service configuration, and start all services using Docker Compose. Ensure to replace `{YOUR_SERVER_IP}` with your actual server IP address.

```bash
# Clone the repository
git clone https://github.com/iflytek/astron-rpa.git
cd astron-rpa

# Enter docker directory
cd docker

# Copy .env
cp .env.example .env

# Modify casdoor service configuration in .env (8000 is the default port)
CASDOOR_EXTERNAL_ENDPOINT="http://{YOUR_SERVER_IP}:8000"

# 🚀 Start all services
docker compose up -d

# 📊 Check service status
docker compose ps
```

--------------------------------

### Build RPA Client (Windows)

Source: https://github.com/iflytek/astron-rpa/blob/main/BUILD_GUIDE.zh.md

Executes the build script for the RPA client on Windows. Specify the Python executable path for custom installations.

```bash
./build.bat -p "C:\Program Files\Python313\python.exe"
```

```bash
./build.bat
```

--------------------------------

### Example Log Entry for File Download

Source: https://github.com/iflytek/astron-rpa/blob/main/backend/resource-service/README.md

This log entry indicates a successful file download operation, referencing the file ID.

```log
2024-01-01 10:30:16.456 INFO  [http-nio-8030-exec-2] c.i.r.r.f.s.i.FileServiceImpl : File download successful, file ID: file-uuid-12345
```

--------------------------------

### Get Robot List API Response

Source: https://context7.com/iflytek/astron-rpa/llms.txt

Example response structure for the robot list API, including total count and records.

```json
// Response:
{
    "code": "0000",
    "data": {
        "total": 15,
        "records": [
            {
                "robotId": "robot_12345",
                "name": "Invoice Processor",
                "status": 1,
                "updatedAt": "2024-01-15T10:30:00Z"
            }
        ]
    }
}
```

--------------------------------

### POST /api/workflows/execute-async

Source: https://context7.com/iflytek/astron-rpa/llms.txt

Starts workflow execution and returns immediately with an execution ID. Use for long-running workflows.

```APIDOC
## POST /api/workflows/execute-async

### Description
Starts workflow execution and returns immediately with an execution ID.

### Method
POST

### Endpoint
/api/workflows/execute-async

### Request Body
- **project_id** (string) - Required - ID of the project
- **version** (string) - Required - Version string
- **parameters** (object) - Required - Execution parameters

### Response
#### Success Response (202)
- **executionId** (string) - The ID of the started execution
```

--------------------------------

### Spring Boot Application Startup Class

Source: https://github.com/iflytek/astron-rpa/blob/main/backend/resource-service/README.md

The main entry point for the Spring Boot application. It initializes the application context and starts the embedded server.

```java
package com.iflytek.rpa.resource;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class ResourceApplication {

    public static void main(String[] args) {
        SpringApplication.run(ResourceApplication.class, args);
    }

}
```

--------------------------------

### Start ATLAS Container for Database Migration

Source: https://github.com/iflytek/astron-rpa/blob/main/FAQ.md

Initiate the ATLAS container to automatically apply database schema changes. This method preserves existing data while updating table structures.

```bash
docker-compose up -d atlas
```

--------------------------------

### Build Application with Options

Source: https://github.com/iflytek/astron-rpa/blob/main/BUILD_GUIDE.md

Execute the build script with specific paths for Python and 7-Zip.

```bash
./build.bat -p "D:\Python313\python.exe" -s "D:\7-Zip\7z.exe"
```

--------------------------------

### Get Dropdown Selected Value

Source: https://context7.com/iflytek/astron-rpa/llms.txt

Retrieves the currently selected value from a dropdown element. Set `current_content` to True to get the selected value, or False to get all options.

```python
# Get dropdown selected value
selected = BrowserElement.get_select(
    browser_obj=browser,
    element_data=dropdown_element,
    current_content=True  # True for selected, False for all options
)
```

--------------------------------

### Get and Set Element Attributes in Astron RPA

Source: https://context7.com/iflytek/astron-rpa/llms.txt

Use BrowserElement.element_operation to get or set attributes of a browser element. Specify the operation type (Get or Set) and attribute details.

```python
value = BrowserElement.element_operation(
    browser_obj=browser,
    element_data=element_data,
    operation_type=ElementAttributeOpTypeFlag.Get,
    get_type=ElementGetAttributeTypeFlag.GetAttribute,
    attribute_name="data-value"
)
```

```python
BrowserElement.element_operation(
    browser_obj=browser,
    element_data=element_data,
    operation_type=ElementAttributeOpTypeFlag.Set,
    attribute_name="data-value",
    attribute_value="new_value"
)
```

--------------------------------

### Execute meta configuration script

Source: https://github.com/iflytek/astron-rpa/blob/main/engine/README.md

Navigate to the engine directory and run the automation script.

```bash
cd engine
```

```bash
python meta_json.py
```

--------------------------------

### View Build Script Help

Source: https://github.com/iflytek/astron-rpa/blob/main/BUILD_GUIDE.md

Display all available parameters and options for the Astron RPA client build script. Use this to customize the build process.

```bash
./build.bat --help
```

--------------------------------

### Build Project with Maven

Source: https://github.com/iflytek/astron-rpa/blob/main/backend/resource-service/README.md

Use this command to clean the project and package it into a JAR file, skipping tests.

```bash
mvn clean package -DskipTests
```

--------------------------------

### Development

Source: https://github.com/iflytek/astron-rpa/blob/main/frontend/packages/cli/README.md

Instructions for setting up and developing the CLI package itself.

```APIDOC
## Development

If you are developing this CLI package itself:

```bash
# Install dependencies
pnpm install

# Build the CLI
pnpm build

# Run type check
pnpm typecheck

# Watch mode for development
pnpm dev
```
```

--------------------------------

### Get Worksheet Names

Source: https://context7.com/iflytek/astron-rpa/llms.txt

Retrieve the names of worksheets in a workbook using `get_excel_worksheet_names`. You can get all sheet names or just the currently active one.

```python
from astronverse.excel.excel import Excel
from astronverse.excel import SheetRangeType

# Get worksheet names
all_names = Excel.get_excel_worksheet_names(
    excel=excel,
    sheet_range=SheetRangeType.ALL
)

active_name = Excel.get_excel_worksheet_names(
    excel=excel,
    sheet_range=SheetRangeType.ACTIVATED
)
```

--------------------------------

### Troubleshoot Packaging Script

Source: https://github.com/iflytek/astron-rpa/blob/main/BUILD_GUIDE.md

Check system resources and dependencies for packaging failures.

```bash
# ✅ Check all dependencies in preparation phase are fully installed

# 💾 Check disk space
dir  # Windows check available space
```

--------------------------------

### Build Library for Production

Source: https://github.com/iflytek/astron-rpa/blob/main/frontend/packages/cli/README.md

Use the `rpa build` command to build the library for production. The `--watch` option enables watch mode.

```bash
rpa build
```

```bash
rpa build --watch
```

--------------------------------

### GET /api/api-keys/get

Source: https://context7.com/iflytek/astron-rpa/llms.txt

Retrieves all API keys for the current user.

```APIDOC
## GET /api/api-keys/get

### Description
Retrieves all API keys for the current user.

### Method
GET

### Endpoint
/api/api-keys/get

### Parameters
#### Query Parameters
- **pageNo** (integer) - Optional - Page number
- **pageSize** (integer) - Optional - Number of records per page
```

--------------------------------

### Monitor Server Logs

Source: https://github.com/iflytek/astron-rpa/blob/main/FAQ.md

Follow the server logs in real-time to monitor the build and startup process. This is useful for debugging and ensuring all services are initializing correctly.

```bash
docker-compose logs -f
```

--------------------------------

### GET /api/executions/{execution_id}

Source: https://context7.com/iflytek/astron-rpa/llms.txt

Retrieves the status and result of a workflow execution.

```APIDOC
## GET /api/executions/{execution_id}

### Description
Retrieves the status and result of a workflow execution.

### Method
GET

### Endpoint
/api/executions/{execution_id}

### Parameters
#### Path Parameters
- **execution_id** (string) - Required - The ID of the execution to retrieve
```

--------------------------------

### GET /admin/user/points

Source: https://github.com/iflytek/astron-rpa/blob/main/backend/ai-service/README.md

Queries the current points balance for a specific user.

```APIDOC
## GET /admin/user/points

### Description
Queries the current points balance for a specific user.

### Method
GET

### Endpoint
/admin/user/points

### Parameters
#### Query Parameters
- **user_id** (string) - Required - The ID of the user to query
```

--------------------------------

### GET /v1/models

Source: https://github.com/iflytek/astron-rpa/blob/main/backend/ai-service/README.zh.md

Retrieves a list of all supported AI models with their metadata.

```APIDOC
## GET /v1/models

### Description
Lists all supported AI models, returning model names, IDs, and metadata for dynamic discovery.

### Method
GET

### Endpoint
/v1/models
```

--------------------------------

### Get Browser Element Text

Source: https://context7.com/iflytek/astron-rpa/llms.txt

Retrieves the text content of a web element.

```python
# Get element text content
text = BrowserElement.element_text(
    browser_obj=browser,
    element_data=element_data,
    element_timeout=10
)
```

--------------------------------

### Build RPA Client with Custom Paths (Windows)

Source: https://github.com/iflytek/astron-rpa/blob/main/BUILD_GUIDE.zh.md

Advanced options for the build script, allowing specification of Python and 7-Zip executable paths.

```bash
./build.bat --python-exe "D:\Python313\python.exe"
```

```bash
./build.bat --sevenz-exe "D:\7-Zip\7z.exe"
```

```bash
./build.bat -p "D:\Python313\python.exe" -s "D:\7-Zip\7z.exe"
```

--------------------------------

### Build Application for Windows

Source: https://github.com/iflytek/astron-rpa/blob/main/frontend/packages/electron-app/README.md

Execute this command to build the Electron application specifically for Windows.

```bash
pnpm build:win
```

--------------------------------

### Element Visibility and Scrolling

Source: https://github.com/iflytek/astron-rpa/blob/main/backend/ai-service/app/prompts/smart/web_auto_prompt.md

Provides methods to get the HTML source of an element and to scroll it into view.

```APIDOC
## GET /api/elements/{elementId}/html

### Description
Returns the outerHTML source code of the web element.

### Method
GET

### Endpoint
`/api/elements/{elementId}/html`

### Response
#### Success Response (200)
- **htmlSource** (string) - The outerHTML of the element.

#### Response Example
```json
{
  "htmlSource": "<div id='myElement'>...</div>"
}
```

## POST /api/elements/{elementId}/scrollIntoView

### Description
Scrolls the element into the viewport. This action is triggered when the element is not visible.

### Method
POST

### Endpoint
`/api/elements/{elementId}/scrollIntoView`

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Element scrolled into view successfully."
}
```
```

--------------------------------

### Build Docker Image

Source: https://github.com/iflytek/astron-rpa/blob/main/backend/resource-service/README.md

Build a Docker image for the resource service, tagging it as 'resource-service:latest'.

```bash
docker build -t resource-service:latest .
```

--------------------------------

### Get Current Page Information

Source: https://context7.com/iflytek/astron-rpa/llms.txt

Retrieve the current URL, title, and tab ID of the active browser.

```python
# Get current page information
url = browser.get_url()           # Returns: "https://example.com/page"
title = browser.get_title()       # Returns: "Page Title"
tab_id = browser.get_tabid()      # Returns: 12345
```

--------------------------------

### Initialize Browser Instance

Source: https://context7.com/iflytek/astron-rpa/llms.txt

Get the active browser instance. This method auto-detects and connects to Chrome, Edge, or Firefox.

```python
from astronverse.browser.browser import Browser
from astronverse.browser.browser_element import get_default_browser, BrowserElement

# Get the active browser instance
browser = get_default_browser()  # Auto-detects Chrome, Edge, or Firefox
```

--------------------------------

### Get All Process Data API Request

Source: https://context7.com/iflytek/astron-rpa/llms.txt

Use this POST request to retrieve all data for processes associated with a robot.

```json
// Get all process data
// POST /api/process/all-data
{
    "robotId": "robot_12345",
    "robotVersion": 0
}
```

--------------------------------

### Troubleshoot Docker Service

Source: https://github.com/iflytek/astron-rpa/blob/main/BUILD_GUIDE.md

Commands to diagnose Docker service startup failures.

```bash
# 🔍 Check port usage
netstat -tulpn | grep :8080

# ✅ Check Docker status
docker --version
docker compose --version

# 📋 View detailed error logs
docker compose logs
```

--------------------------------

### Configure Server Address in conf.yaml

Source: https://github.com/iflytek/astron-rpa/blob/main/README.md

Modify the server address in the `resources/conf.yaml` file after installation. Ensure the port matches your configuration.

```yaml
# 32742 is the default port; change it if you modified the configuration
remote_addr: http://YOUR_SERVER_ADDRESS:32742/
skip_engine_start: false
```

--------------------------------

### Build Application for Linux

Source: https://github.com/iflytek/astron-rpa/blob/main/frontend/packages/electron-app/README.md

Execute this command to build the Electron application specifically for Linux.

```bash
pnpm build:linux
```

--------------------------------

### Locate Exe Package

Source: https://github.com/iflytek/astron-rpa/blob/main/BUILD_GUIDE.md

Path to the generated executable file after building.

```text
/frontend/packages/electron-app/dist/
```

--------------------------------

### Run All Tests with pytest

Source: https://github.com/iflytek/astron-rpa/blob/main/backend/openapi-service/README.md

Execute all tests in the project using the pytest framework. Ensure the test database is started first.

```bash
# Start test database
docker-compose -f docker-compose.test.yaml up -d

# Run all tests
pytest
```

--------------------------------

### Reinstall pywinhook

Source: https://github.com/iflytek/astron-rpa/blob/main/BUILD_GUIDE.md

After ensuring SWIG is correctly installed and configured in your system's environment variables, reinstall pywinhook using pip.

```bash
pip install pywinhook
```

--------------------------------

### Build Astron RPA Client with Custom Paths

Source: https://github.com/iflytek/astron-rpa/blob/main/BUILD_GUIDE.md

Use these parameters with the build script to specify custom paths for the Python executable and the 7-Zip executable.

```bash
# 🔧 Specify Python path
./build.bat --python-exe "D:\Python313\python.exe"

# 🔧 Specify 7-Zip path
./build.bat --sevenz-exe "D:\7-Zip\7z.exe"
```

--------------------------------

### Apply Code Formatting with Maven

Source: https://github.com/iflytek/astron-rpa/blob/main/backend/resource-service/README.md

Use the 'mvn spotless:apply' command to format the code according to defined style guidelines.

```bash
mvn spotless:apply
```

--------------------------------

### View Application Logs in Real-time

Source: https://github.com/iflytek/astron-rpa/blob/main/backend/resource-service/README.md

Monitor the application logs in real-time by using the 'tail -f' command on the 'application.log' file.

```bash
tail -f logs/application.log
```

--------------------------------

### Run Astron RPA Locally

Source: https://github.com/iflytek/astron-rpa/blob/main/backend/robot-service/README.md

Execute the packaged JAR file for local development. Replace sensitive configurations in `application-local.yml` before running. You can adjust the port and context path.

```bash
java -jar target/robot-0.0.1-SNAPSHOT.jar --spring.profiles.active=local
```

```bash
# Optional: adjust port/context
# --server.port=8040 --server.servlet.context-path=/api/robot
```

--------------------------------

### Get Opened Excel File by Filename with Astron Excel Engine

Source: https://context7.com/iflytek/astron-rpa/llms.txt

Retrieve an already opened Excel instance by its filename using Excel.get_excel.

```python
# Get already opened Excel by filename
excel = Excel.get_excel(file_name="report.xlsx")
```

--------------------------------

### Build and Test AstronRPA Frontend

Source: https://github.com/iflytek/astron-rpa/blob/main/frontend/README.md

Commands for building web and desktop applications, running tests, and performing code linting and internationalization file generation.

```bash
pnpm build:web

pnpm build:desktop

pnpm test

pnpm test:ui

pnpm lint:fix

pnpm i18n
```

--------------------------------

### Execute Workflow Asynchronously

Source: https://context7.com/iflytek/astron-rpa/llms.txt

Starts a workflow execution and returns immediately with an execution ID. This is recommended for long-running workflows. The response will have an HTTP status of 202.

```json
# POST /api/workflows/execute-async
# Headers: X-API-Key: your_api_key
{
    "project_id": "proj_12345",
    "version": "1.0.0",
    "parameters": {"email": "user@example.com"}
}
```

```json
# Response (HTTP 202):
{
    "code": "0000",
    "msg": "",
    "data": {
        "executionId": "exec_67890"
    }
}
```

```text
# Poll for status:
# GET /api/executions/exec_67890
```

--------------------------------

### Deploy with Docker Compose

Source: https://github.com/iflytek/astron-rpa/blob/main/backend/ai-service/README.md

Deploy the production environment using Docker Compose. Ensure the .env file is configured.

```bash
docker-compose up -d
```

--------------------------------

### Development Environment Commands

Source: https://github.com/iflytek/astron-rpa/blob/main/backend/ai-service/README.md

Commands for managing the test database, running tests, and checking code quality.

```bash
# Start test database
docker-compose -f docker-compose.test.yaml up -d

# Run all tests
pytest

# Run specific test file
pytest tests/routers/test_chat.py

# Run tests with coverage
pytest --cov=app
```

```bash
# Format code
ruff format

# Check code quality
ruff check

# Fix auto-fixable issues
ruff check --fix
```

--------------------------------

### AI Chat Completion Request Body

Source: https://github.com/iflytek/astron-rpa/blob/main/backend/ai-service/README.md

Example JSON payload for the AI chat completions endpoint. Includes model, messages, and generation parameters.

```json
{
  "model": "deepseek-chat",
  "messages": [
    {"role": "system", "content": "You are a helpful assistant."},
    {"role": "user", "content": "Hello!"}
  ],
  "stream": false,
  "temperature": 0.7,
  "max_tokens": 4096
}
```

--------------------------------

### Build RPA Client Skipping Components

Source: https://github.com/iflytek/astron-rpa/blob/main/BUILD_GUIDE.zh.md

Builds the RPA client while skipping either the engine or the frontend components.

```bash
./build.bat --skip-frontend
```

```bash
./build.bat --skip-engine
```

--------------------------------

### Get Robot List API Request

Source: https://context7.com/iflytek/astron-rpa/llms.txt

Use this POST request to retrieve a paginated list of robots for the current user. Supports searching by keyword and sorting.

```json
// POST /api/robot-design/design-list
{
    "pageNo": 1,
    "pageSize": 20,
    "keyword": "",  // optional search keyword
    "sortBy": "updatedAt",
    "sortOrder": "desc"
}
```

--------------------------------

### Get Workflow Execution Status

Source: https://context7.com/iflytek/astron-rpa/llms.txt

Retrieves the current status and results of a specific workflow execution using its ID. The status can be 'pending', 'running', 'completed', or 'failed'.

```bash
# GET /api/executions/{execution_id}
# Headers: X-API-Key: your_api_key

curl -X GET "http://localhost:8000/api/executions/exec_67890" \
  -H "X-API-Key: your_api_key"
```

```json
# Response:
{
    "code": "0000",
    "msg": "",
    "data": {
        "execution": {
            "id": "exec_67890",
            "project_id": "proj_12345",
            "status": "running",  # pending, running, completed, failed
            "progress": 45,
            "started_at": "2024-01-15T10:30:00Z",
            "result": null
        }
    }
}
```

--------------------------------

### View Application Logs in Real-time

Source: https://github.com/iflytek/astron-rpa/blob/main/backend/openapi-service/README.md

Monitor the application's log file in real-time to observe ongoing activity and potential issues.

```bash
tail -f logs/app.log
```

--------------------------------

### Build Docker Image for Astron RPA

Source: https://github.com/iflytek/astron-rpa/blob/main/backend/robot-service/README.md

Build a Docker image for the Astron RPA project. Ensure the JAR file exists in the `target/` directory before building.

```bash
docker build -t robot:local .
```

--------------------------------

### Configure Pip Mirror Source

Source: https://github.com/iflytek/astron-rpa/blob/main/FAQ.zh.md

Set a domestic mirror source to improve dependency download speed and reliability.

```ini
# pip 配置示例
[global]
index-url = https://mirrors.aliyun.com/pypi/simple/
trusted-host = mirrors.aliyun.com
```