> For the complete documentation index, see [llms.txt](https://docs.pritunl.com/kb/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pritunl.com/kb/vpn/client/cli-interface.md).

# Command Line Interface

Pritunl command line interface usage

The `pritunl-client` package is available on Linux for installing the Pritunl Client on servers without the GUI interface.

### Configuring a Profile

To add a profile run the command below with a URI link from the Pritunl server web console.

```shell
# Import Pritunl URI profile
pritunl-client add pritunl://demo.pritunl.com/ku/rBCDSgw5

# Import Pritunl tar profile
pritunl-client add pritunl_user_profile.tar
```

When the profile is first added it must be manually started. First run `pritunl-client list` to get the ID of the profile. Then start the profile, partial IDs can be used. To start the profile with OpenVPN add the argument `--mode=ovpn` for WireGuard use `--mode=wg`.

```shell
pritunl-client list
pritunl-client start 5ac --mode=ovpn
```

All profiles will start on startup and a configuration sync will be done before connecting. If the client disconnects a profile sync will run before reconnecting. This allows making modifications to the Pritunl server without needing to make changes on the client. It is not recommended to configure auto starting profiles that require two-factor authentication.

### macOS

The macOS CLI client is available at `/Applications/Pritunl.app/Contents/Resources/pritunl-client`.

### Windows

The Windows CLI client is available at `C:\Program Files (x86)\Pritunl\pritunl-client.exe`.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.pritunl.com/kb/vpn/client/cli-interface.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.