ca42ca2ca8
This commit adds a VitePress build to the main repository, aiming to ditch GitHub Wiki. Moving further, we're going to host our own documentation site eithor on GitHub Pages or something alike.
39 lines
1.4 KiB
Markdown
39 lines
1.4 KiB
Markdown
---
|
|
sidebarTitle: "Feature: Script Shortcuts"
|
|
sidebarOrder: 6
|
|
---
|
|
|
|
# Script Shortcuts
|
|
|
|
Clash Premium implements the Scripting feature powered by Python3, enableing users to programmatically select policies for the packets with dynamic flexibility.
|
|
|
|
You can either controll the entire rule-matching engine with a single Python script, or define a number of shortcuts and use them in companion with the regular rules. This page refers to the latter feature, for the former, see [Script](./script.md).
|
|
|
|
This feature enables the use of script in `rules` mode. By default, DNS resolution takes place for SCRIPT rules. `no-resolve` can be appended to the rule to prevent the resolution. (i.e.: `SCRIPT,quic,DIRECT,no-resolve`)
|
|
|
|
**NOTE: ****`src_port`**** and ****`dst_port`**** are number**
|
|
|
|
```yaml
|
|
mode: Rule
|
|
|
|
script:
|
|
shortcuts:
|
|
quic: network == 'udp' and dst_port == 443
|
|
curl: resolve_process_name() == 'curl'
|
|
# curl: resolve_process_path() == '/usr/bin/curl'
|
|
|
|
rules:
|
|
- SCRIPT,quic,REJECT
|
|
```
|
|
|
|
## Function Definitions
|
|
|
|
```ts
|
|
type resolve_ip = (host: string) => string // ip string
|
|
type in_cidr = (ip: string, cidr: string) => boolean // ip in cidr
|
|
type geoip = (ip: string) => string // country code
|
|
type match_provider = (name: string) => boolean // in rule provider
|
|
type resolve_process_name = () => string // find process name (curl .e.g)
|
|
type resolve_process_path = () => string // find process path (/usr/bin/curl .e.g)
|
|
```
|