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)

BindPlane CLI can be run remotely (from a workstation), packages and binary releases are available on the Downloads page.

For macOS and Windows, place the BindPlane binary / exe in the user's path or execute it directly. For Debian and RHEL platforms, the installation is the same as BindPlane server, however, only the BindPlane binary is installed (User and config, log, storage directories are not created).

CLI Commands

CommandDescription
applyApply resources
completionGenerate the autocompletion script for the specified shell
deleteDelete bindplane resources
getDisplay one or more resources
helpHelp about any command
installInstall a new agent
labelList or modify the labels of a resource
profileProfile commands.
serveStarts the server
validatevalidate the current profile
versionPrints BindPlane version
FlagsDescription
--config string, -cfull path to configuration file
--help, -hhelp for bindplane
--host stringdomain on which the BindPlane server will run (default "localhost")
--log-file-path stringfull path of the BindPlane log file, defaults to $HOME/bindplane.log
--output string, -ooutput format. One of: json|table|yaml|raw (default "table")
--password stringpassword to use with Basic auth (default "admin")
--port stringport on which the rest server is listening (default "3001")
--profile stringconfiguration profile name to use
--server-url stringhttp url that clients use to connect to the server
--tls-ca stringsTLS certificate authority file(s) for mutual TLS authentication
--tls-cert stringTLS certificate file
--tls-key stringTLS private key file
--username stringusername to use with Basic auth (default "admin")