> For the complete documentation index, see [llms.txt](https://surge.mitsea.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://surge.mitsea.com/scripting/rule.md).

# 规则

使用脚本作为规则。value 字段将被用作规则名称。

`rule ssid-rule script-path=ssid-rule.js`

然后在 `[Rule]` 段落中添加一行：

`SCRIPT,ssid-rule,DIRECT`

脚本应该返回一个带有 `matched` 属性的对象，以指示是否匹配。

传入的参数包括：

* `$request.hostname<String>`
* `$request.destPort<Number>`
* `$request.processPath<String>`
* `$request.userAgent<String>`
* `$request.url<String>`
* `$request.sourceIP<String>`
* `$request.listenPort<Number>`
* `$request.dnsResult<Object>`
* `$request.srcPort<Number>` iOS 5.8.4+ Mac 5.4.4+
* `$request.protocol<Number>` iOS 5.8.4+ Mac 5.4.4+

默认情况下，`SCRIPT` 规则不会触发 DNS 查询。您可以使用 `requires-resolve` 选项来更改此行为。

`SCRIPT,ssid-rule,DIRECT,requires-resolve`

DNS 结果包含在 `$request.dnsResult` 中。

一个简单的示例：

```javascript
var hostnameMatched = ($request.hostname === 'home.com');
var ssidMatched = ($network.wifi.ssid === 'My Home');

$done({matched: (hostnameMatched && ssidMatched)});
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://surge.mitsea.com/scripting/rule.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.