Doover CLI Overview

The Doover CLI (doover-cli) is the official command-line interface for interacting with the Doover IoT platform. It provides tools for application development, deployment, device management, and platform interaction from your terminal.

What is Doover CLI?

Doover CLI is a comprehensive tool that enables developers to:

Create applications - Scaffold new Doover applications from templates
Build and deploy - Build Docker images and publish applications to the Doover platform
Manage channels - Create, publish to, and subscribe to Doover channels
Access devices remotely - Open SSH tunnels to remote devices
Generate reports - Compose reports from agent data
Manage configuration - Export, validate, and generate configuration schemas

Installation

Doover CLI can be installed using several methods:

Using uv (Recommended)

uv tool install doover-cli

Using pipx

pipx install doover-cli

Using pip

pip install doover-cli

Debian Package

For Debian-based systems, a .deb package is available. Contact Doover support for the latest package version.

Basic Usage

After installation, the CLI is available via the doover command:

doover <command> [options]

Global Options

Option	Description
`--debug`	Enable debug output, including detailed error messages
`--json`	Output results in JSON format
`--version`	Display the CLI version
`--help`	Show help information

Check Version

doover --version

Available Commands

The Doover CLI provides the following command groups:

Command	Description
`app`	Manage applications and their configurations
`channel`	Manage channels and their configurations
`agent`	Manage agents and their configurations
`tunnel`	Manage SSH tunnels for remote access
`config-schema`	Manage application config schemas
`report`	Generate and manage reports
`grpc`	Interact with running gRPC servers
`simulator`	Manage simulators and their configurations
`doover-config`	Manage doover configuration files
`dda-logs`	Convert DDA message logs to JSON
`login`	Authenticate with the Doover platform
`configure-token`	Configure token-based authentication

Getting Help

To see help for any command:

doover --help
doover app --help
doover app create --help

Relationship to pydoover

The Doover CLI is built on top of the pydoover Python library. While pydoover provides programmatic access to the Doover platform through Python code, doover-cli offers a convenient command-line interface for common operations.

Key integration points:

ConfigManager - The CLI uses pydoover's ConfigManager for storing authentication credentials and profiles
Cloud API - All platform interactions go through pydoover's cloud API client
Channel Operations - Channel management uses pydoover's channel classes (Task, Processor, Message)

If you need more advanced programmatic control, you can use the pydoover library directly in your Python code while using the CLI for routine operations.

Quick Start

Install the CLI:
```
uv tool install doover-cli
```
Authenticate:
```
doover login
```
Create a new application:
```
doover app create
```

Build and run locally:

cd your-app-name
doover app build
doover app run

Publish to Doover:
```
doover app publish
```

Next Steps

Authentication - Learn about login and token configuration
Application Management - Create, build, and deploy applications
Channel Commands - Work with Doover channels
Tunnel Commands - Set up remote device access