Skip to main content

Kodemeio GLPI CLI - manage GLPI IT Service Management platform

Project description

kctl-glpi

GLPI IT asset management CLI — manage tickets, assets, users, entities, plugins, and health for your GLPI IT Service Management platform.

Installation

uv tool install kctl-glpi

Requires kctl-lib>=0.4.0 (installed automatically).

For workspace development:

cd /path/to/kodemeio-cli
uv sync --all-extras --all-packages

Configuration

Config lives in ~/.config/kodemeio/config.yaml under the glpi service key, using the standard Kodemeio profile system.

# Interactive setup
kctl-glpi config init

# Add a named profile
kctl-glpi config add --profile production \
  --url https://glpi.kodeme.io \
  --app-token <glpi-app-token> \
  --user-token <glpi-user-token>

# Switch active profile
kctl-glpi config use production

# Show current config (secrets masked)
kctl-glpi config show

Example ~/.config/kodemeio/config.yaml entry:

profiles:
  kodemeio:
    glpi:
      url: https://glpi.kodeme.io
      app_token: ${GLPI_APP_TOKEN}
      user_token: ${GLPI_USER_TOKEN}

Use -p/--profile or KCTL_GLPI_PROFILE env var to select a profile.

Command Groups

Group Description Key Commands
config Profile and credential management init, add, use, show, validate, remove, set, profiles, current
tickets Helpdesk ticket lifecycle list, get, create, update, assign, close
assets Computer and hardware assets list, get, create, update, types
users GLPI user management list, get, create, search
entities Organizational entity hierarchy list, get, tree
search Flexible GLPI search API query, fields
plugins Plugin lifecycle management list, enable, disable
health Connectivity and API health check, dashboard
dashboard Platform overview overview
doctor Diagnostic checks with AI summary ai-summary
commands AI agent discovery list, tree
completions Shell completion install zsh, bash, fish
self-update Upgrade via uv tool
tui Terminal user interface

Examples

Ticket Management

# List all open tickets
kctl-glpi -p production tickets list

# Get a specific ticket
kctl-glpi -p production tickets get 1234

# Create a new ticket
kctl-glpi -p production tickets create \
  --title "Network outage in server room" \
  --description "Switches unreachable since 09:00" \
  --priority 4

# Assign ticket to a user
kctl-glpi -p production tickets assign 1234 --user-id 42

# Close a resolved ticket
kctl-glpi -p production tickets close 1234

Asset Inventory

# List all computer assets
kctl-glpi -p production assets list

# Get details for a specific asset
kctl-glpi -p production assets get 56

# Create a new asset record
kctl-glpi -p production assets create \
  --name "srv-prod-01" \
  --serial "SN12345ABC"

# List available asset types
kctl-glpi -p production assets types

User and Entity Management

# Search for a user
kctl-glpi -p production users search --query "john"

# List entity hierarchy
kctl-glpi -p production entities tree

# View entity details
kctl-glpi -p production entities get 1

Health and Diagnostics

# Quick health check
kctl-glpi -p production health check

# Full dashboard status
kctl-glpi -p production health dashboard

# AI-ready diagnostic summary (for agent workflows)
kctl-glpi -p production --json doctor ai-summary

Global Options

Option Short Description
--profile -p Config profile name (or KCTL_GLPI_PROFILE)
--format -f Output format: pretty, json, csv, yaml
--json Shortcut for --format json
--quiet -q Suppress info messages
--no-header Omit headers in CSV output
--url GLPI API URL override
--app-token GLPI App-Token override
--user-token GLPI User-Token override
--version -V Show version and exit

Development

cd packages/kctl-glpi
uv sync --all-extras
uv run pytest tests/ -v
uv run mypy src/
uv run ruff check src/
uv build

Standards

Follows the Kodemeio CLI standard — profile inheritance, --json machine output, doctor ai-summary, commands list --json for agent discovery, and skill generate for SKILL.md auto-generation.

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

kctl_glpi-0.7.1.tar.gz (25.3 kB view details)

Uploaded Source

Built Distribution

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

kctl_glpi-0.7.1-py3-none-any.whl (30.3 kB view details)

Uploaded Python 3

File details

Details for the file kctl_glpi-0.7.1.tar.gz.

File metadata

  • Download URL: kctl_glpi-0.7.1.tar.gz
  • Upload date:
  • Size: 25.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.20 {"installer":{"name":"uv","version":"0.11.20","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for kctl_glpi-0.7.1.tar.gz
Algorithm Hash digest
SHA256 cdaae215eff9c13b1193aead3b8405b8dde1ef8fdd1a1cbd6de7f8bb1055c9a1
MD5 7a2a0ee6be05638a0723df12fc2c3d21
BLAKE2b-256 99042b9744e847ffcb1194ceba2f4eea427706e386ab28c5227c10aa23af683e

See more details on using hashes here.

File details

Details for the file kctl_glpi-0.7.1-py3-none-any.whl.

File metadata

  • Download URL: kctl_glpi-0.7.1-py3-none-any.whl
  • Upload date:
  • Size: 30.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.20 {"installer":{"name":"uv","version":"0.11.20","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for kctl_glpi-0.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 15edfe3b0b0214cac2e93166a88275e80c2d4e218432b973fb0887d599681edc
MD5 c72d2d335f5639fbe7d825f61eb5cd46
BLAKE2b-256 651f19217c66d08fb0490f0e9f06e652690a9c126845a6cae9cc4feea8b6a995

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