mirror of
https://github.com/XTLS/Xray-core.git
synced 2025-08-23 18:16:50 +08:00
API: Improve cli usage descriptions (#4401)
This commit is contained in:
@@ -8,20 +8,28 @@ import (
|
||||
var cmdInboundUser = &base.Command{
|
||||
CustomFlags: true,
|
||||
UsageLine: "{{.Exec}} api inbounduser [--server=127.0.0.1:8080] -tag=tag [-email=email]",
|
||||
Short: "Get Inbound User",
|
||||
Short: "Retrieve inbound user(s)",
|
||||
Long: `
|
||||
Get User info from an inbound.
|
||||
|
||||
Arguments:
|
||||
-s, -server
|
||||
|
||||
-s, -server <server:port>
|
||||
The API server address. Default 127.0.0.1:8080
|
||||
-t, -timeout
|
||||
Timeout seconds to call API. Default 3
|
||||
|
||||
-t, -timeout <seconds>
|
||||
Timeout in seconds for calling API. Default 3
|
||||
|
||||
-tag
|
||||
Inbound tag
|
||||
-email
|
||||
User email. If email is not given, will get all users
|
||||
|
||||
-email
|
||||
The user's email address. If not provided, all users will be retrieved.
|
||||
|
||||
Example:
|
||||
{{.Exec}} {{.LongName}} --server=127.0.0.1:8080 -tag="tag name" -email="xray@love.com"
|
||||
|
||||
{{.Exec}} {{.LongName}} --server=127.0.0.1:8080 -tag="tag name"
|
||||
{{.Exec}} {{.LongName}} --server=127.0.0.1:8080 -tag="tag name" -email="xray@love.com"
|
||||
`,
|
||||
Run: executeInboundUser,
|
||||
}
|
||||
|
Reference in New Issue
Block a user