Skip to content

Doover CLI Overview

The doover CLI is a command-line tool for interacting with the Doover platform. It wraps the pydoover SDK and provides commands for managing applications, devices, channels, tunnels, users, and organisations from your terminal.

Installation

Install via pip or uv:

pip install doover-cli
uv tool install doover-cli

This installs the doover command globally. The CLI requires Python 3.11 or later.

Information Circle

The doover CLI is a separate package from pydoover. You can use either independently, but the CLI depends on pydoover internally.

Quick Start

Log in to your Doover account:

doover login

This opens a browser window where you enter a device code displayed in your terminal. Once authorised, your credentials are saved to a local profile and used automatically for subsequent commands.

List your applications:

doover app list

Get details about a specific device:

doover device get "my-device"

Publish an application:

doover app publish --build-container

Global Options

These options are available on every doover command:

OptionDescription
--debugEnable debug output, including full error tracebacks
--jsonOutput results in JSON format
--renderSet output renderer: default (Rich formatted), json, or basic (plain text)
--versionShow the CLI version and exit

The --json flag is a shortcut for --render json. They are mutually exclusive.

Command Groups

The CLI is organised into command groups, each managing a different aspect of the platform:

Command GroupDescription
doover loginAuthenticate with the Doover platform
doover appCreate, build, publish, and manage applications
doover deviceList, create, and manage devices and device types
doover channelGet, create, publish to, and follow channels
doover tunnelCreate and manage remote access tunnels
doover config-schemaExport, validate, and generate config schemas
doover ui-schemaExport and validate UI schemas
doover users / doover orgManage users, organisations, roles, and invitations
doover agentList and inspect agents
doover reportGenerate reports locally

Output Formats

By default, the CLI uses Rich for formatted table and tree output. You can switch to JSON for scripting:

# Formatted table output (default)
doover app list

# JSON output for scripting
doover app list --json

# Plain text output
doover app list --render basic

Profiles

The CLI uses named profiles to store authentication credentials. Profiles are saved in ~/.doover/config and can be selected per-command with the --profile flag.

# Use a specific profile
doover app list --profile staging

# Log in to create a new profile
doover login --profile production

See Authentication for full details on profiles and the login flow.

Related Pages