CLI
You can access the BindPlane CLI by using the bindplane command from the install directory or preceded by the absolute path of the install directory.
Installing BindPlane Client (Remote CLI)
See the Installation page for install instructions.
CLI Commands
| Command | Description |
|---|---|
apply | Apply resources |
completion | Generate the autocompletion script for the specified shell |
copy | Make a copy of a resource |
delete | Delete bindplane resources |
get | Display one or more resources |
help | Help about any command |
init | Initialize an installation |
install | Install a new agent |
label | List or modify the labels of a resource |
profile | Profile commands. |
serve | Starts the server |
sync | Sync an agent-version from github |
update | Update an existing agent |
upload | Upload an offline agent upgrade package |
version | Prints BindPlane version |
rollout | Manage one or more rollout |
| Flags | Description | ||
|---|---|---|---|
-c, --config string | full path to configuration file | ||
--env string | BindPlane environment. One of test | development | production (default "production") |
-h, --help | help for bindplane | ||
--host string | domain on which the BindPlane server will run (default "localhost") | ||
--logging-file-path string | full path of the BindPlane log file, defaults to $HOME/.bindplane/bindplane.log | ||
--logging-output string | output of the log. One of: file | stdout | |
--tracing-otlp-endpoint string | endpoint to send OTLP traces to | ||
--tracing-otlp-insecure | set true to allow insecure TLS | ||
-o, --output string | output format. One of: json|table|yaml|raw (default "table") | ||
--password string | password to use with Basic auth (default "admin") | ||
--port string | port on which the rest server is listening (default "3001") | ||
--profile string | configuration profile name to use | ||
--remote-url string | http url that clients use to connect to the server | ||
--tls-ca strings | TLS certificate authority file(s) for mutual TLS authentication | ||
--tls-cert string | TLS certificate file | ||
--tls-key string | TLS private key file | ||
--tls-skip-verify | Whether to verify the server's certificate chain and host name when making client requests | ||
--tracing-type string | type of trace to use for tracing requests, either 'otlp' or 'google' | ||
--username string | username to use with Basic auth (default "admin") |