Plyrana CLI — manage any self-hosted Plyrana instance from your terminal. Auth, devices, variables, automations, system.
Project description
plyrana-cli — Terminal client for Plyrana
Thin command-line client for the Plyrana IoT Device Hub REST API. Great for CI/CD, scripting, batch operations.
Install
pip install plyrana-cli
# dev install from source:
pip install -e ./cli
First run
# Point to your hub
plyrana config set-url https://hub.example.com
# Login (password prompt if omitted)
plyrana auth login --email admin@example.com
# Verify
plyrana auth status
Commands
Auth
plyrana auth login --email <EMAIL>
plyrana auth logout
plyrana auth status
Devices
plyrana devices list [--limit 50] [--type hardware]
plyrana devices get <UID>
plyrana devices claim <UID>
plyrana devices unclaim <UID>
Variables
plyrana variables list [--device <UID>]
plyrana variables get <UID> <KEY>
plyrana variables set <UID> <KEY> <VALUE> # auto-cast: 22.5 / true / '{"x":1}'
plyrana variables history <UID> <KEY> [--limit 20]
Automations
plyrana automations list
plyrana automations run <ID>
plyrana automations toggle <ID> --on | --off
System
plyrana system health # public, no auth
plyrana system license # CE / Pro / Enterprise + limits
plyrana system integrations # MQTT / HA / Prometheus / Grafana status
plyrana system metrics # Prometheus text-format
Config
plyrana config show
plyrana config set-url <URL>
plyrana config clear
Auth storage
Tokens are stored in ~/.plyrana/config.json with 0600 perms (best-effort on Windows).
Override via env:
PLYRANA_URL=https://hub.example.comPLYRANA_TOKEN=eyJ...
Env beats file — great for CI.
Example: CI smoke-test
export PLYRANA_URL=https://hub.example.com
export PLYRANA_TOKEN=$PLYRANA_CI_TOKEN
plyrana system health || exit 1
plyrana devices list --limit 1 || exit 1
License
AGPL-3.0 — see LICENSE in the main repo.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file plyrana_cli-0.2.0.tar.gz.
File metadata
- Download URL: plyrana_cli-0.2.0.tar.gz
- Upload date:
- Size: 12.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7979f1cc1720df3c44d244c32137e1f304686915b3b1e3ec26ae63edefdd0d13
|
|
| MD5 |
e15093a2ed04771e6f0b1cb02fca0945
|
|
| BLAKE2b-256 |
8c6d3147b6ebe20d3e591bc06be7c12f3011d4a775bc7a1354486fe6b92e6776
|
File details
Details for the file plyrana_cli-0.2.0-py3-none-any.whl.
File metadata
- Download URL: plyrana_cli-0.2.0-py3-none-any.whl
- Upload date:
- Size: 16.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1919001c3d6643d4f0bc01e366f08b76c43fdeabc64a978e6a20cfe5eb6cb75d
|
|
| MD5 |
077dba39c9fbaffc748c78b07ef73f80
|
|
| BLAKE2b-256 |
ba5a86fc61cad9e656f60235333c3b4f6a6d28ebb2a4a6346a641f0e18c491c2
|