命令行客户端
参数与子命令
frpc 的全局参数、生效优先级与子命令。
全局参数
| 参数 | 类型 | 说明 |
|---|---|---|
-c, --config | string | 配置文件路径,可重复或用逗号分隔。默认为 ./frpc.ini。 |
--config_dir | string | 指定目录,目录下每个文件启动一个实例。默认不启用。 |
-t, --token | string | 快捷启动凭据,格式为 <id[,id2,...]>:<token>,可重复。默认不启用。 |
-v, --version | bool | 打印版本号后退出。默认为 false。 |
--strict_config | bool | 严格解析配置,遇到未知字段时报错。默认为 true。 |
--allow-unsafe | string | 允许使用的不安全特性,可选值为 TokenSourceExec。默认不启用。 |
-h, --help | bool | 打印帮助。 |
./frpc -v
LoliaFRP-CLI 0.71.4
--strict_config 默认为开启,配置中出现当前版本不认识的字段时会解析失败。使用旧配置或排查兼容问题时可以加 --strict_config=false,不建议长期关闭。
优先级
| 优先级 | 条件 | 行为 |
|---|---|---|
| 1 | 指定 -t | 按快捷启动处理,忽略 -c 与 --config_dir。 |
| 2 | 未指定 -t,指定 --config_dir | 按目录为每个文件启动实例。 |
| 3 | 未指定以上两者,指定多个 -c | 每个文件启动一个实例。 |
| 4 | 只指定一个 -c 或未指定 | 启动单个实例,未指定时读取 ./frpc.ini。 |
子命令
| 子命令 | 说明 |
|---|---|
frpc verify | 校验配置文件。 |
frpc status | 查看运行中实例的隧道状态。 |
frpc reload | 热重载配置文件。 |
frpc stop | 停止运行中的实例。 |
frpc nathole discover | 通过 STUN 探测 NAT 类型与公网映射。 |
frpc <type> | 不读取配置文件,直接用参数启动一个隧道。 |
frpc <type> visitor | 以访问者身份连接 stcp、sudp、xtcp 隧道。 |
<type> 可选值为 tcp、udp、tcpmux、http、https、stcp、sudp、xtcp,其中 stcp、sudp、xtcp 提供 visitor 子命令。
status、reload、stop 通过配置文件中的 webServer 调用本地管理接口,未配置 webServer.port 时输出 web server port should be set if you want to use this feature。这三个子命令只读取 -c 指定的配置文件,快捷启动模式下没有本地配置文件,无法使用。--api-timeout 用于指定调用超时,默认为 30s。
verify 校验通过时输出 frpc: the configuration file ./frpc.toml syntax is ok。
在 frpc <type> 与 frpc <type> visitor 子命令中,-t 表示 frps 的鉴权 token,不是快捷启动凭据。
示例
# 校验配置
./frpc verify -c ./frpc.toml
# 查看隧道状态
./frpc status -c ./frpc.toml
# 热重载,超时 10 秒
./frpc reload -c ./frpc.toml --api-timeout 10s
# 停止实例
./frpc stop -c ./frpc.toml
# 不读取配置文件,直接启动一个 TCP 隧道
./frpc tcp -n ssh -l 22 -r 6000 -s cn-frp-1.qwq.fan -P 7000 -t <frps 鉴权 token>
# 以访问者身份连接 stcp 隧道
./frpc stcp visitor -n ssh-visitor --server_name ssh --sk <secretKey> --bind_port 2222