# xui-deploy

Automates installing and configuring [3x-ui](https://github.com/MHSanaei/3x-ui) (Xray panel) on a remote VPS over SSH.

## Architecture
![Architecture](assets/xui-deploy-architecture.svg)

## Workflow
![Workflow](assets/xui-deploy-workflow.svg)

## When to Use

Activate this skill when the user wants to:
- Deploy or install x-ui / 3x-ui on a VPS
- Set up an Xray proxy panel
- Update an existing x-ui installation
- Configure panel port, credentials, or base path

Trigger phrases: `deploy x-ui`, `install x-ui`, `setup xui`, `install 3x-ui`, `xray panel`, `部署x-ui`, `安装x-ui`, `搭建xui`, `xray面板`

## How It Works

1. Collects VPS host, SSH credentials, and panel settings from the user
2. Tests SSH connectivity and checks OS compatibility
3. Runs the official 3x-ui one-line installer (handles fresh install and updates)
4. Configures panel port, username, password, and web base path via `x-ui` CLI
5. Restarts the service and verifies it is running
6. Opens the panel port in the system firewall (ufw or firewalld)
7. Reports the panel URL and credentials

## File Structure

```
xui-deploy/
├── SKILL.md          # Instructions for the agent
├── evals/
│   └── evals.json    # 4 test cases
└── assets/
    ├── architecture.puml
    ├── xui-deploy-architecture.svg
    ├── workflow.puml
    └── xui-deploy-workflow.svg
```

## Evals

```bash
python scripts/run_evals.py xui-deploy
```