CLI Reference

This page documents the stable v2.1.2 CLI baseline. The repository main branch is a 2.1.3 development channel and can contain extra commands that are not part of this stable reference.

Grammar

<verb> <resource> [target] [property] [value]

Host role decides which commands appear in Tab/help. There is no separate server ... / client ... top-level namespace.

Interactive keys

Tab   show/complete valid next tokens
?     detailed contextual explanation
Enter execute
↑/↓   session-only history

Tab does not execute commands. frpctl history is not written to disk.

Client selector

The canonical selector is CLIENT ID: immutable short machine identity. Changing label, note, tags, or hostname never changes CLIENT ID.

show clients prints CLIENT ID first.
Tab completes CLIENT ID.
A unique label/hostname can be typed manually.
Ambiguous selectors fail closed.
user@host:port is not a client selector.

Show

show status
show version
show clients
show client <ID>
show client <ID> services
show client <ID> tags
show enrollments
show audit
show upstream
show services
show info

status and version remain compatibility shortcuts for the show form.

Set

Server:

set client <ID> label <value>
set client <ID> note <value>
set client <ID> tag <key> <value>
set installer-url <url>
set server hostname <fqdn>

Client:

set service <service-id> target-host <host>
set service <service-id> target-port <port>
set service <service-id> ssh-user <user>
set service <service-id> name <value>

Service IDs are immutable. Client-side pending changes become live after apply.

Unset

unset client <ID> label
unset client <ID> note
unset client <ID> tag <key>
unset server hostname

unset removes metadata; it does not release public ports or change identity.

Create / add

create zero-touch
create enrollment [--one-line] [--ssh --ssh-user USER --label NAME]
create enrollments --count N
create enrollments --csv clients.csv
create backup [path]
add service [--preset ssh|http|https|custom] ...

create zero-touch is the recommended everyday onboarding path.

Enable / disable / apply / discard

enable service <service-id>
disable service <service-id>
apply
discard

Disabling a service keeps the public-port reservation. apply does not release server ports.

Revoke / release / restore

revoke client <ID>
revoke enrollment <ID>
release service <ID> <service-id>
release client <ID>
restore backup <path>

These are never aliases. There is intentionally no ambiguous delete client command.

Update

update project [--check]
update frp [--check]

FRP remains pinned to the tested project version. show upstream is informational.

Other

doctor
help
help show
help set client
help legacy
?
show ?
set client <ID> ?
menu
history
clear
exit

Stable enrollment states

show enrollments can represent enrollment records in normalized lifecycle states such as:

pending
bound
completed
expired
revoked

Secrets are never printed by show, Tab, or help output.

The 2.1.3 development tree adds explicit terminal enrollment purge/retention commands and bootstrap-hostname controls. Do not assume those commands exist on a stable v2.1.2 server.

Compatibility aliases

Alias	Canonical
`clients`	`show clients`
`client` / `client-info`	`show client`
`client-set` / `edit-client`	`set client` / `unset client`
`enroll` / `create-client`	`create enrollment`
`enroll-bulk`	`create enrollments`
`enrollments`	`show enrollments`
`enrollment-revoke`	`revoke enrollment`
`revoke` / `revoke-client`	`revoke client`
`release-service`	`release service`
`release-client`	`release client`
`project-update` / `client-update`	`update project`
`frp-update` / `server-update`	`update frp`
`backup`	`create backup`
`restore PATH`	`restore backup PATH`
`upstream`	`show upstream`
`audit`	`show audit`
`services` / `manage` / `info`	`show services` / `add`+`set service` / `show info`
`status` / `version`	`show status` / `show version`

Getting Started

Client & Services

frpctl

Deployment

Operations

Security & Reference

CLI Reference

CLI Reference

Grammar

Interactive keys

Client selector

Show

Set

Unset

Create / add

Enable / disable / apply / discard

Revoke / release / restore

Update

Other

Stable enrollment states

Compatibility aliases

​CLI Reference

​Grammar

​Interactive keys

​Client selector

​Show

​Set

​Unset

​Create / add

​Enable / disable / apply / discard

​Revoke / release / restore

​Update

​Other

​Stable enrollment states

​Compatibility aliases

CLI Reference

Grammar

Interactive keys

Client selector

Show

Set

Unset

Create / add

Enable / disable / apply / discard

Revoke / release / restore

Update

Other

Stable enrollment states

Compatibility aliases