Skip to main content

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.com
  • PLYRANA_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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

plyrana_cli-0.1.0.tar.gz (9.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

plyrana_cli-0.1.0-py3-none-any.whl (12.2 kB view details)

Uploaded Python 3

File details

Details for the file plyrana_cli-0.1.0.tar.gz.

File metadata

  • Download URL: plyrana_cli-0.1.0.tar.gz
  • Upload date:
  • Size: 9.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for plyrana_cli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 826207b69dacfff85d09df766c0065d81bf31ca411795e72dc138e2891b76918
MD5 b5fc349f7b2569c908df1adbbcbb0078
BLAKE2b-256 8d8c1ce12dae7c3c4cb0052b323ccd0bf37f2dcdd195b7b524aa6641a75d7780

See more details on using hashes here.

File details

Details for the file plyrana_cli-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: plyrana_cli-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 12.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for plyrana_cli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 89ab23e3177cdc2de945654538e35eae86060068cf0563a57a4f86c209b5bd72
MD5 8b3599c43e7bfc9ff71694294e667cfb
BLAKE2b-256 2ef543ef7e43a6865c392ceca812d6d5a7591ecdb1babe69688e7f5e50ca4214

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page