Skip to navigation

Passport CLI overview

The Passport CLI (passport) is a command-line tool for connecting to and interacting with the Passport Proxy. It handles authentication, client machine setup, identity verification, and routing API requests through Passport. Use it to connect your machine to the proxy, verify your identity, and send authenticated API requests from the terminal or scripts.

Each command supports the --help option for inline usage information. For example, passport setup --help.

Install

To install the Passport CLI on your own machine, see Install the Passport CLI. IT teams that manage many machines should deploy the Passport CLI with mobile device management.

Options

The following options are available on the passport command:

-v, --version

Output the version number.

--silent

Silence all terminal output.

--color <value>
Defaults to auto

Turn on or off colored output. Accepts auto, on, or off.

--theme <name>
Defaults to passport

Set the color theme. Accepts passport, matrix, nord, or mocha.

--no-animation

Turn off all motion effects.

--ascii

Force ASCII-only rendering (no Unicode or braille characters).

-h, --help

Display help for the command.

The --theme, --no-animation, and --ascii options apply to the terminal dashboard.

Commands

CommandDescription
passportOpen the terminal dashboard.
passport authInspect the Passport authentication session.
passport caManage OS trust for the Passport CA.
passport daemonManage the local daemon that transparently routes outbound API calls.
passport loginAuthenticate with Passport.
passport logoutSign out and delete the stored API key.
passport logsView Passport logs (daemon and command activity).
passport logs:clearArchive current logs and start fresh.
passport requestForward an HTTPS request through the Passport Proxy.
passport setupProvision a client certificate for your machine.
passport whoamiShow the identity in the stored client certificate.