Metadata-Version: 2.4
Name: scorpio-cli
Version: 0.1.0.6
Summary: Scorpio IoT command-line interface
Author-email: Pedro Zavala <pedropablozavalatejos@gmail.com>, IoT-UC Laboratory <scorpioiotuc@gmail.com>
Maintainer-email: Pedro Zavala <pedropablozavalatejos@gmail.com>
Project-URL: Homepage, https://github.com/ScorpioIoTUC/scorpio-cli/
Project-URL: Issues, https://github.com/ScorpioIoTUC/scorpio-cli/issues
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: paramiko<4,>=3.5
Requires-Dist: tzlocal<6,>=5
Dynamic: license-file

# Scorpio CLI

Command-line installer and local setup interface for Scorpio IoT UC.

# Installation
## Install on Debian or Raspberry Pi OS

Debian-based systems protect the system Python environment. Install Scorpio CLI
with `pipx` instead of using `sudo pip` or `--break-system-packages`.

```bash
sudo apt update
sudo apt install pipx
pipx ensurepath
source ~/.profile
pipx install scorpio-cli
```


## Commands

```text
scorpio ui             Start the setup interface
scorpio setup          Install host dependencies
scorpio setup-docker   Configure and start Docker infrastructure
scorpio start          Start Scorpio services
scorpio stop           Stop Scorpio services and preserve data
scorpio status         Show service status
scorpio logs           Follow service logs
scorpio build          Build Docker images
scorpio reset          Stop services and permanently remove Docker data
```

`scorpio reset` requires explicit confirmation because it removes the MQTT and
SQLite Docker volumes.

Upgrade or uninstall the CLI with:

```bash
pipx upgrade scorpio-cli
pipx uninstall scorpio-cli
```
