Xray-docs-next/docs/document/command.md

2.1 KiB
Raw Blame History

命令参数

::: tip Xray 使用 Go 风格的命令及参数 :::

获取基本命令

您可以运行 xray help 来获得所有 xray 最基础的用法, 以及可用的命令及说明.

Xray is a platform for building proxies.

Usage:

        xray <command> [arguments]

The commands are:

        run          Run Xray with config, the default command
        version      Show current version of Xray
        api          Call an API in an Xray process
        tls          TLS tools
        uuid         Generate new UUIDs

Use "xray help <command>" for more information about a command.

xray run

指定一个或多个配置文件,并运行。

使用方法:

 xray run [-c config.json] [-confdir dir]
Run Xray with config, the default command.

The -config=file, -c=file flags set the config files for
Xray. Multiple assign is accepted.

The -confdir=dir flag sets a dir with multiple json config

The -format=json flag sets the format of config files.
Default "json".

The -test flag tells Xray to test config files only,
without launching the server

xray version

输出 Xray 版本、 Golang 版本等信息。

使用方法:

 xray version

xray api

调用 Xray 的 gRPC API需要在配置文件中开启。

使用方法:

xray api <command> [arguments]
        restartlogger Restart the logger
        stats         Get statistics
        statsquery    Query statistics
        statssys      Get system statistics
        adi           Add inbounds
        ado           Add outbounds
        rmi           Remove inbounds
        rmo           Remove outbounds

xray tls

一些与 TLS 相关的工具。

使用方法:

xray tls <command> [arguments]
        cert         Generate TLS certificates
        ping         Ping the domain with TLS handshake

xray uuid

生成 UUID。

使用方法:

xray uuid

::: tip 当-config没有指定时Xray 将先后尝试从以下路径加载config.json:

  • 工作目录Working Directory
  • 环境变量Xray.location.asset所指定的路径 :::