> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xray.cool/llms.txt
> Use this file to discover all available pages before exploring further.

# xray 2.0 系列通用参数

## 简介（Introduction）

因为xray 2.0系列工具使用的是统一的引擎，所以很多通用函数都可以直接使用，这里将介绍一些常用的通用函数。

## 参数介绍（Parameters）

### 通用参数（Common parameters）

| 命令                    | 接收参数          | 解释                                       | demo           |
| --------------------- | ------------- | ---------------------------------------- | -------------- |
| `--run`<br />`-r`     | `filepath`    | 仅执行：仅执行指定的插件，支持glob/绝对路径/相对路径            | [🔎](#run)     |
| `--group`<br />`-g`   | `filepath`    | 插件组：执行指定的插件组文件                           | [🔎](#group)   |
| `--disable`<br />`-d` | `plugin_name` | 禁用：禁止特定插件执行，仅支持输入插件名<br />也就是插件的`name`字段 | [🔎](#disable) |
| `--config`            | `filepath`    | 配置文件：使用指定的配置文件<br />如果文件不存在则自动创建默认配置文件   |                |

### HTTP客户端管理（HTTP Client Management）

| 命令全称                       | 接收参数   | 解释                                                        | demo              |
| -------------------------- | ------ | --------------------------------------------------------- | ----------------- |
| `--host_rps`<br />`--hrps` | `int`  | 对于单个Host的每秒最大发送请求数: <br />小于等于0时不限制每秒最大发送请求数 (default: 0) |                   |
| `--http-proxy`             | `代理地址` | HTTP客户端代理，仅对http连接生效                                      | [🔎](#http-proxy) |
| `--retry`                  | `int`  | 请求失败重试次数 (default: 2)                                     |                   |

### 连接管理（Connection management）

| 命令全称        | 接收参数   | 解释                               | demo         |
| ----------- | ------ | -------------------------------- | ------------ |
| `--proxy`   | `代理地址` | 全局代理，仅支持socks5，对所有连接生效           | [🔎](#proxy) |
| `--timeout` | `int`  | 读超时: 从连接中读取数据的最大耗时 (default: 5s) |              |

### 插件展示（Plugin Showcase）

| 命令全称 | 解释                       | demo |
| ---- | ------------------------ | ---- |
| `-v` | 列出启用的插件 (default: false) |      |

### 目标拆解（Target disassembly）

| 命令全称 | 接收参数       | 解释                                          | demo          |
| ---- | ---------- | ------------------------------------------- | ------------- |
| `-i` | `filepath` | 目标文件: 指定含有扫描目标的文本文件                         |               |
| `-t` | `value`    | 扫描目标: 可以为URL/IP/域名/Host:Port等多种形式的混合输入 （默认） | [🔎](#target) |

### 结果输出（Result Output）

| 命令全称 | 接收参数       | 解释                | demo          |
| ---- | ---------- | ----------------- | ------------- |
| `-o` | `filepath` | 结果输出: 指定保存结果的文件路径 | [🔎](#output) |

### 日志管理（Log Management）

| 命令全称          | 解释                                           | demo |
| ------------- | -------------------------------------------- | ---- |
| `--debug`     | 调试：打印debug日志 (default: false)                |      |
| `--log-level` | 指定等级：debug/info(默认)/warn/error/fatal/disable |      |
| `--silent`    | 静默：不打印banner，日志等级设置为fatal (default: false)   |      |

## 通用功能（Common Functions）

### 反连优化（Reverse Optimization）

在xray2.0系列工具中，我们优化了反连的功能，当前在没有配置反连的前提下，会默认使用dnslog.cn作为反连的服务器使用。

### 配置文件（Configuration File）

最新版本的xray2.0系列工具都会在其对应的**配置文件夹**处创建一个example文件，同时不会再创建默认配置文件，如果希望修改配置，可以复制example文件并去掉example，修改其中内容即可

<Accordion title="配置文件夹（Configuration Folder）">
  * Windows：`C:\Users\<用户名>\.xray\xapp`
  * Linux\MacOS：`~/.xray/xapp`
</Accordion>

## Demo

### run

```bash theme={null}
xapp -r xxx.yml -t http://192.168.1.1:8000
xapp -r xxx.yml -r yyy.yml -t http://192.168.1.1:8000
xapp -r "/path/*.yml"  -t http://192.168.1.1:8000
xapp.exe -r /path/*.yml  -t http://192.168.1.1:8000
```

### group

```bash theme={null}
xapp -g xxx.list -t http://192.168.1.1:8000
xapp -g xxx.list -g yyy.list -t http://192.168.1.1:8000
```

### disable

```bash theme={null}
xapp -g test.list -d fingerprint-yaml-Azure -t http://192.168.1.1:8000
```

### http-proxy

`[http|https|socks5://][username[:password]@]host[:port]`

### proxy

`socks5://[username[:password]@]host[:port]`

### target

```bash theme={null}
xapp -g test.list -t http://192.168.1.1:8000
echo https://xray.cool | xapp -g test.list
```

### output

目前支持的结果输出格式有：

* xpoc：html，json
* xapp：json
