# 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](https://docs.bindplane.com/cli-and-api/cli/installation) page for install instructions.

### CLI Commands

<table><thead><tr><th width="164.1875">Command</th><th>Description</th></tr></thead><tbody><tr><td><code>apply</code></td><td>Apply resources</td></tr><tr><td><code>completion</code></td><td>Generate the autocompletion script for the specified shell</td></tr><tr><td><code>copy</code></td><td>Make a copy of a resource</td></tr><tr><td><code>delete</code></td><td>Delete bindplane resources</td></tr><tr><td><code>get</code></td><td>Display one or more resources</td></tr><tr><td><code>help</code></td><td>Help about any command</td></tr><tr><td><code>init</code></td><td>Initialize an installation</td></tr><tr><td><code>install</code></td><td>Install a new collector</td></tr><tr><td><code>label</code></td><td>List or modify the labels of a resource</td></tr><tr><td><code>profile</code></td><td>Profile commands.</td></tr><tr><td><code>serve</code></td><td>Starts the server</td></tr><tr><td><code>sync</code></td><td>Sync a collector-version from github</td></tr><tr><td><code>update</code></td><td>Update an existing collector</td></tr><tr><td><code>upload</code></td><td>Upload an offline collector upgrade package</td></tr><tr><td><code>version</code></td><td>Prints Bindplane version</td></tr><tr><td><code>rollout</code></td><td>Manage one or more rollout</td></tr></tbody></table>

<table><thead><tr><th width="147.5703125">Flags</th><th>Description</th><th width="155.390625"></th><th width="127.91015625"></th></tr></thead><tbody><tr><td><code>-c</code>, <code>--config string</code></td><td>full path to configuration file</td><td></td><td></td></tr><tr><td><code>--env string</code></td><td>Bindplane environment. One of test</td><td>development</td><td>production (default "production")</td></tr><tr><td><code>-h</code>, <code>--help</code></td><td>help for bindplane</td><td></td><td></td></tr><tr><td><code>--host string</code></td><td>domain on which the Bindplane server will run (default "localhost")</td><td></td><td></td></tr><tr><td><code>--logging-file-path string</code></td><td>full path of the Bindplane log file, defaults to $HOME/.bindplane/bindplane.log</td><td></td><td></td></tr><tr><td><code>--logging-output string</code></td><td>output of the log. One of: file</td><td>stdout</td><td></td></tr><tr><td><code>--tracing-otlp-endpoint string</code></td><td>endpoint to send OTLP traces to</td><td></td><td></td></tr><tr><td><code>--tracing-otlp-insecure</code></td><td>set true to allow insecure TLS</td><td></td><td></td></tr><tr><td><code>-o</code>, <code>--output string</code></td><td>output format. One of: json|table|yaml|raw (default "table")</td><td></td><td></td></tr><tr><td><code>--password string</code></td><td>password to use with Basic auth (default "admin")</td><td></td><td></td></tr><tr><td><code>--port string</code></td><td>port on which the rest server is listening (default "3001")</td><td></td><td></td></tr><tr><td><code>--profile string</code></td><td>configuration profile name to use</td><td></td><td></td></tr><tr><td><code>--remote-url string</code></td><td>http url that clients use to connect to the server</td><td></td><td></td></tr><tr><td><code>--tls-ca strings</code></td><td>TLS certificate authority file(s) for mutual TLS authentication</td><td></td><td></td></tr><tr><td><code>--tls-cert string</code></td><td>TLS certificate file</td><td></td><td></td></tr><tr><td><code>--tls-key string</code></td><td>TLS private key file</td><td></td><td></td></tr><tr><td><code>--tls-skip-verify</code></td><td>Whether to verify the server's certificate chain and host name when making client requests</td><td></td><td></td></tr><tr><td><code>--tracing-type string</code></td><td>type of trace to use for tracing requests, either 'otlp' or 'google'</td><td></td><td></td></tr><tr><td><code>--username string</code></td><td>username to use with Basic auth (default "admin")</td><td></td><td></td></tr></tbody></table>
