Skip to main content

Command-line interface for the Cylera Partner API

Project description

Cylera CLI

A command-line interface for the Cylera Partner API, providing read-only access to device inventory, threats, vulnerabilities, and network information.

It can be used stand-alone or integrated into an AI workflow using the bundled Claude Code skill (see below).

Alternatively, if you are looking to incorporate the power of Cylera into your AI workflows, you may also consider the Cylera MCP Server.

This Cylera AI Integration Options document may help you decide which one may make sense depending on your AI workflows.

Demo

Demo

Requirements

  • uv
  • Credentials for accessing Cylera

Installation

Install using uv:

uv tool install .

Then run commands directly:

cylera --help

To uninstall:

uv tool uninstall cylera

Alternatively, run without installing:

uvx cylera --help

Configuration

Run the interactive setup to configure your credentials:

cylera init

This will prompt you to:

  1. Select your Cylera API endpoint (US, UK, or Demo)
  2. Enter your username (email)
  3. Enter your password

Credentials are stored in a .env file in the current directory.

Manual Configuration

Alternatively, set environment variables directly:

export CYLERA_BASE_URL="https://partner.us1.cylera.com/"
export CYLERA_USERNAME="your-email@example.com"
export CYLERA_PASSWORD="your-password"

Doppler Secrets Management

Instead of storing the secrets in a .env file, you may choose to use a secrets management solution such as Doppler.

To use Doppler, simply add the following prefix to all commands.

doppler run --

For example, to run "cylera devices" accessing secrets from Doppler, you would run the following:

doppler run -- cylera devices

1Password Secrets Management

Alternatively, you can use 1Password CLI for secrets management. Set your environment ID and prefix commands with op run:

export OP_ENVIRONMENT_ID=<your-environment-id>
op run --environment "$OP_ENVIRONMENT_ID" -- cylera devices

Usage

cylera <command> [options]

Available Commands

Command Description
init Initialize Cylera CLI configuration interactively
organization Get the organization associated with the current credentials
organizations List organizations available to switch into
switchorg Switch to a different organization
resetorg Reset organization back to home
device Get details for a specific device by MAC address
devices Get a list of devices with optional filters
deviceattributes Get attributes for a device by MAC address
procedures Get a list of medical procedures
subnets Get a list of network subnets
riskmitigations Get mitigations for a specific vulnerability
vulnerabilities Get a list of vulnerabilities
threats Get a list of detected threats

Organization

Get organization info:

cylera organization

List available organizations:

cylera organizations

Switch to a different organization:

cylera switchorg <organization-id>

Reset back to home organization:

cylera resetorg

Device Inventory

List devices:

cylera devices --page-size 10
cylera devices --vendor Philips --class Medical
cylera devices --ip-address 10.40

Get a specific device:

cylera device 7f:14:22:72:00:e5

Get device attributes:

cylera deviceattributes 7f:14:22:72:00:e5

Vulnerabilities & Risk

List vulnerabilities:

cylera vulnerabilities --severity CRITICAL
cylera vulnerabilities --status OPEN --page-size 20

Get mitigations for a vulnerability:

cylera riskmitigations "Ripple20 (ICSA-20-168-01)"

Threats

List threats:

cylera threats --severity HIGH
cylera threats --mac-address bb:b0:71:cf:30:0a

Network

List subnets:

cylera subnets
cylera subnets --vlan 477

Medical Procedures

List procedures:

cylera procedures --page-size 10
cylera procedures --completed-after 2025/01/01

Common Options

Most list commands support these options:

Option Description
--page Page number for pagination
--page-size Results per page (max 100)
--mac-address Filter by device MAC address
--severity Filter by severity (INFO, LOW, MEDIUM, HIGH, CRITICAL)
--status Filter by status (OPEN, IN_PROGRESS, RESOLVED, SUPPRESSED)

Output

All commands output JSON to stdout, which can be piped to tools like jq:

cylera devices --page-size 5 | jq '.devices[].hostname'

Debugging

Enable debug output to see request details:

DEBUG=1 cylera devices --page-size 1

API Endpoints

The CLI supports these Cylera Partner API regions:

  • US: https://partner.us1.cylera.com/
  • UK: https://partner.uk1.cylera.com/
  • Demo: https://partner.demo.cylera.com/

Claude Code Skills

This repo includes Claude Code skills for querying Cylera data and exporting results to CSV directly from a conversation — no scripting required.

Skill Description
/cylera-attributes Find devices by attribute label (e.g. TeamViewer, end of life)
/cylera-vulnerabilities Export vulnerabilities filtered by severity and/or status
/cylera-threats Export threats filtered by severity and/or status
/cylera-devices Export device inventory filtered by class, vendor, type, or OS

See CODING_AGENT_SKILLS.md for full installation instructions and usage examples.

License

See LICENSE file for details.

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

cylera_cli-1.1.0.tar.gz (8.5 kB view details)

Uploaded Source

Built Distribution

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

cylera_cli-1.1.0-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

Details for the file cylera_cli-1.1.0.tar.gz.

File metadata

  • Download URL: cylera_cli-1.1.0.tar.gz
  • Upload date:
  • Size: 8.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.4 {"installer":{"name":"uv","version":"0.10.4","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for cylera_cli-1.1.0.tar.gz
Algorithm Hash digest
SHA256 b1d9d2e9bb1f75430f8c0f2819029991e4b9deddadc5251034d71c8b7bd4314f
MD5 d87c8d4d39d8e8d43fc48a66eff48e0b
BLAKE2b-256 d6454235db14db50a3da57cf3daf41e421af1122b4487a62e4accabff016fbd0

See more details on using hashes here.

File details

Details for the file cylera_cli-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: cylera_cli-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 8.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.4 {"installer":{"name":"uv","version":"0.10.4","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for cylera_cli-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 716f2875979de2ac23cfdad26e8e416ce12034edad6ed30a6a93759768edd139
MD5 db345c3ada330356c7855db9bfc81968
BLAKE2b-256 bbb8d79c739faf67d04f47376bf2da3181c9d50f08eca23688090752335d6068

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