mirror of
https://github.com/nitezs/sub2sing-box.git
synced 2024-12-23 20:44:42 -05:00
Add CLI commands and API documentation
This commit is contained in:
parent
baac96fdd1
commit
fe7988f8aa
17
Readme.md
17
Readme.md
@ -1,5 +1,9 @@
|
|||||||
# sub2sing-box
|
# sub2sing-box
|
||||||
|
|
||||||
|
## Cli Command
|
||||||
|
|
||||||
|
### convert
|
||||||
|
|
||||||
```
|
```
|
||||||
Convert common proxy to sing-box proxy
|
Convert common proxy to sing-box proxy
|
||||||
|
|
||||||
@ -16,6 +20,8 @@ Flags:
|
|||||||
-t, --template string template file path
|
-t, --template string template file path
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### server
|
||||||
|
|
||||||
```
|
```
|
||||||
Run the server
|
Run the server
|
||||||
|
|
||||||
@ -27,6 +33,17 @@ Flags:
|
|||||||
-p, --port uint16 server port (default 8080)
|
-p, --port uint16 server port (default 8080)
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### api
|
||||||
|
|
||||||
|
##### GET /convert
|
||||||
|
|
||||||
|
- `data`: Base64 编码的 JSON 字符串,包含以下字段:
|
||||||
|
- `subscription`: []string
|
||||||
|
- `proxy`: []string
|
||||||
|
- `delete`: string
|
||||||
|
- `rename`: string
|
||||||
|
- `template`: string
|
||||||
|
|
||||||
## Template
|
## Template
|
||||||
|
|
||||||
Template 中使用 `<all-proxy-tags>` 指明节点插入位置,例如
|
Template 中使用 `<all-proxy-tags>` 指明节点插入位置,例如
|
||||||
|
Loading…
Reference in New Issue
Block a user